ColorSpecificationBox (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.media.imageioimpl.plugins.jpeg2000.Box
- - io.scif.media.imageioimpl.plugins.jpeg2000.ColorSpecificationBox

```
public class ColorSpecificationBox
extends Box
```
This class is defined to represent a Color Specification Box of JPEG JP2 file format. A Channel Definition Box has a length, and a fixed type of "colr". Its content contains the method to define the color space, the precedence and approximation accuracy (0 for JP2 files), the enumerated color space, and the ICC color profile if any.

Field Summary

Fields
Modifier and Type Field and Description

static int ECS_GRAY

static int ECS_sRGB
The enumerated color space defined in JP2 file format.

static int ECS_YCC
- Fields inherited from class io.scif.media.imageioimpl.plugins.jpeg2000.Box
  data, extraLength, length, type

Fields
Modifier and Type	Field and Description
`static int`	`ECS_GRAY`
`static int`	`ECS_sRGB` The enumerated color space defined in JP2 file format.
`static int`	`ECS_YCC`

Constructor Summary

Constructors
Constructor and Description
`ColorSpecificationBox(byte[] data)` Creates a `ColorSpecificationBox` from the provided byte array.
`ColorSpecificationBox(byte m, byte p, byte a, int ecs, ICC_Profile profile)` Creates a `ColorSpecificationBox` from the provided data elements.
`ColorSpecificationBox(Node node)` Constructs a `ColorSpecificationBox` based on the provided `org.w3c.dom.Node`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`compose()` Composes the content byte array from the data elements.
`byte`	`getApproximationAccuracy()` Returns `ApproximationAccuracy`.
`static String[]`	`getElementNames()` This method will be called by the getNativeNodeForSimpleBox of the class Box to get the element names.
`int`	`getEnumeratedColorSpace()` Returns the enumerated color space.
`ICC_Profile`	`getICCProfile()` Returns the ICC color profile in this color specification box.
`byte`	`getMethod()` Returns the method to define the color space.
`IIOMetadataNode`	`getNativeNode()` Creates an `IIOMetadataNode` from this color specification box.
`byte`	`getPrecedence()` Returns `Precedence`.
`protected void`	`parse(byte[] data)` Parses the data elements from the byte array.

Methods inherited from class io.scif.media.imageioimpl.plugins.jpeg2000.Box
copyInt, createBox, getAttribute, getBoxClass, getByteArrayElementValue, getByteElementValue, getContent, getExtraLength, getIntArrayElementValue, getIntElementValue, getLength, getName, getNativeNodeForSimpleBox, getShortElementValue, getStringElementValue, getType, getTypeByName, getTypeInt, getTypeString, parseByteArray, parseIntArray, read, setContent, setDefaultAttributes, setExtraLength, setLength, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ECS_sRGB
```
public static final int ECS_sRGB
```
    The enumerated color space defined in JP2 file format.
    
    See Also:
    
    Constant Field Values
  - ECS_GRAY
```
public static final int ECS_GRAY
```
    See Also:
    
    Constant Field Values
  - ECS_YCC
```
public static final int ECS_YCC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ColorSpecificationBox
```
public ColorSpecificationBox(byte m,
                             byte p,
                             byte a,
                             int ecs,
                             ICC_Profile profile)
```
    Creates a ColorSpecificationBox from the provided data elements.
  - ColorSpecificationBox
```
public ColorSpecificationBox(byte[] data)
```
    Creates a ColorSpecificationBox from the provided byte array.
  - ColorSpecificationBox
```
public ColorSpecificationBox(Node node)
                      throws IIOInvalidTreeException
```
    Constructs a ColorSpecificationBox based on the provided org.w3c.dom.Node.
    
    Throws:
    
    IIOInvalidTreeException
- Method Detail
  - getElementNames
```
public static String[] getElementNames()
```
    This method will be called by the getNativeNodeForSimpleBox of the class Box to get the element names.
  - getMethod
```
public byte getMethod()
```
    Returns the method to define the color space.
  - getPrecedence
```
public byte getPrecedence()
```
    Returns Precedence.
  - getApproximationAccuracy
```
public byte getApproximationAccuracy()
```
    Returns ApproximationAccuracy.
  - getEnumeratedColorSpace
```
public int getEnumeratedColorSpace()
```
    Returns the enumerated color space.
  - getICCProfile
```
public ICC_Profile getICCProfile()
```
    Returns the ICC color profile in this color specification box.
  - getNativeNode
```
public IIOMetadataNode getNativeNode()
```
    Creates an IIOMetadataNode from this color specification box. The format of this node is defined in the XML dtd and xsd for the JP2 image file.
    
    Overrides:
    
    getNativeNode in class Box
  - parse
```
protected void parse(byte[] data)
```
    Description copied from class: Box
    
    Parses the data elements from the byte array. The subclasses should override this method.
    
    Overrides:
    
    parse in class Box
  - compose
```
protected void compose()
```
    Description copied from class: Box
    
    Composes the content byte array from the data elements.
    
    Overrides:
    
    compose in class Box

Class ColorSpecificationBox

Field Summary

Fields inherited from class io.scif.media.imageioimpl.plugins.jpeg2000.Box

Constructor Summary

Method Summary

Methods inherited from class io.scif.media.imageioimpl.plugins.jpeg2000.Box

Methods inherited from class java.lang.Object

Field Detail

ECS_sRGB

ECS_GRAY

ECS_YCC

Constructor Detail

ColorSpecificationBox

ColorSpecificationBox

ColorSpecificationBox

Method Detail

getElementNames

getMethod

getPrecedence

getApproximationAccuracy

getEnumeratedColorSpace

getICCProfile

getNativeNode

parse

compose