public final class StandardAttributes extends Object
The current OpenEXR standard attributes are:
(1.0, 1.0, 1.0)
.
If the chromaticities
and the whiteLuminance
of an RGB image
are known, then it is possible to convert the image's pixels from RGB
to CIE XYZ tristimulus values.adoptedNeutral
value should
be mapped to neutral values on the display.xDensity * pixelAspectRatio
.
whereyyyy:MM:dd HH:mm:ss
yyyy
is the year (4 digits, e.g. 2003), MM
is the month
(2 digits, 01, 02, ... 12), dd
is the day of the month (2 digits,
01, 02, ... 31), HH
is the hour (2 digits, 00, 01, ... 23) mm
is the minute, and ss
is the second (2 digits, 00, 01, ... 59).capDate
from
Universal Coordinated Time (UTC) in seconds:
UTC = local time + utcOffset
EnvMap
.framesPerSecond
attribute, and the attribute should be
the same for all images in the sequence. If an image sequence has
no framesPerSecond
attribute, playback software should assume that
the frame rate for the sequence is 24 frames per second.
In order to allow exact representation of NTSC frame and field rates,
framesPerSecond
is stored as a rational number. A rational number is
a pair of integers, n
and d
, that represents the value
n/d
.
multiView
attribute
lists the names of the views in an image, and a naming convention
identifies the channels that belong to each view.The camera coordinate space is left-handed. Its origin indicates the location of the camera. The positive x and y axes correspond to the "right" and "up" directions in the rendered image. The positive z axis indicates the camera's viewing direction. (Objects in front of the camera have positive z coordinates.)
Camera coordinate space in OpenEXR is the same as in Pixar's Renderman.
NDC is a 2D coordinate space that corresponds to the image plane, with positive x pointing to the right and positive y pointing down. The coordinates (0, 0) and (1, 1) correspond to the upper left and lower right corners of the OpenEXR display window.
To transform a 3D point in world space into a 2D point in NDC space,
multiply the 3D point by the worldToNDC
matrix and discard the
z coordinate.
NDC space in OpenEXR is the same as in Pixar's Renderman.
Modifier and Type | Method and Description |
---|---|
static void |
addAdoptedNeutral(Header header,
Vector2<Float> value)
Add or update the
adoptedNeutral standard attribute
to the given header using value . |
static void |
addAltitude(Header header,
float value)
Add or update the
altitude standard attribute
to the given header using value . |
static void |
addAperture(Header header,
float value)
Add or update the
aperture standard attribute
to the given header using value . |
static void |
addCapDate(Header header,
String value)
Add or update the
capDate standard attribute
to the given header using value . |
static void |
addCapDateAndUtcOffset(Header header,
Date date)
Add or update both the
capDate and utcOffset standard
attributes to represent the given date (UTC milliseconds since
the Epoch.) in the default time zone for this host. |
static void |
addCapDateAndUtcOffset(Header header,
Date date,
TimeZone zone)
Add or update both the
capDate and utcOffset standard
attributes to represent the given date (UTC milliseconds since
the Epoch.) in a certain time zone. |
static void |
addChromaticities(Header header,
Chromaticities value)
Add or update the
chromaticities standard attribute
to the given header using a non-null value . |
static void |
addComments(Header header,
String value)
Add or update the
comments standard attribute
to the given header using value . |
static void |
addEnvMap(Header header,
EnvMap value)
Add or update the
envmap standard attribute
to the given header using value . |
static void |
addExpTime(Header header,
float value)
Add or update the
expTime standard attribute
to the given header using value . |
static void |
addFocus(Header header,
float value)
Add or update the
focus standard attribute
to the given header using value . |
static void |
addFramesPerSecond(Header header,
Rational value)
Add or update the
framesPerSecond standard attribute
to the given header using value . |
static void |
addIsoSpeed(Header header,
float value)
Add or update the
isoSpeed standard attribute
to the given header using value . |
static void |
addKeyCode(Header header,
KeyCode value)
Add or update the
keyCode standard attribute
to the given header using value . |
static void |
addLatitude(Header header,
float value)
Add or update the
latitude standard attribute
to the given header using value . |
static void |
addLongitude(Header header,
float value)
Add or update the
longitude standard attribute
to the given header using value . |
static void |
addLookModTransform(Header header,
String value)
Add or update the
lookModTransform standard attribute
to the given header using value . |
static void |
addMultiView(Header header,
List<String> value)
Add or update the
multiView standard attribute
to the given header using value . |
static void |
addOwner(Header header,
String value)
Add or update the
owner standard attribute
to the given header using value . |
static void |
addRenderingTransform(Header header,
String value)
Add or update the
renderingTransform standard attribute
to the given header using value . |
static void |
addTimeCode(Header header,
TimeCode value)
Add or update the
timeCode standard attribute
to the given header using value . |
static void |
addUtcOffset(Header header,
float value)
Add or update the
utcOffset standard attribute
to the given header using value . |
static void |
addWhiteLuminance(Header header,
float value)
Add or update the
whiteLuminance standard attribute
to the given header using value . |
static void |
addWorldToCamera(Header header,
Matrix44<Float> value)
Add or update the
worldToCamera standard attribute
to the given header using value . |
static void |
addWorldToNDC(Header header,
Matrix44<Float> value)
Add or update the
worldToNDC standard attribute
to the given header using value . |
static void |
addWrapmodes(Header header,
String value)
Add or update the
wrapmodes standard attribute
to the given header using value . |
static void |
addXDensity(Header header,
float value)
Add or update the
xDensity standard attribute
to the given header using value . |
static Vector2<Float> |
getAdoptedNeutral(Header header)
Returns a reference to the current value of an existing
adoptedNeutral standard attribute. |
static V2fAttribute |
getAdoptedNeutralAttribute(Header header)
Returns a reference to an existing
adoptedNeutral standard attribute. |
static float |
getAltitude(Header header)
Returns a reference to the current value of an existing
altitude standard attribute. |
static FloatAttribute |
getAltitudeAttribute(Header header)
Returns a reference to an existing
altitude standard attribute. |
static float |
getAperture(Header header)
Returns a reference to the current value of an existing
aperture standard attribute. |
static FloatAttribute |
getApertureAttribute(Header header)
Returns a reference to an existing
aperture standard attribute. |
static String |
getCapDate(Header header)
Returns a reference to the current value of an existing
capDate standard attribute. |
static StringAttribute |
getCapDateAttribute(Header header)
Returns a reference to an existing
capDate standard attribute. |
static Date |
getCapDateTime(Header header)
Returns a
Date instance representing the current value of the
capDate and utcOffset standard attributes. |
static Chromaticities |
getChromaticities(Header header)
Returns a reference to the current value of an existing
chromaticities standard attribute. |
static ChromaticitiesAttribute |
getChromaticitiesAttribute(Header header)
Returns a reference to an existing
chromaticities standard attribute. |
static String |
getComments(Header header)
Returns a reference to the current value of an existing
comments standard attribute. |
static StringAttribute |
getCommentsAttribute(Header header)
Returns a reference to an existing
comments standard attribute. |
static EnvMap |
getEnvMap(Header header)
Returns a reference to the current value of an existing
envmap standard attribute. |
static EnvMapAttribute |
getEnvMapAttribute(Header header)
Returns a reference to an existing
envmap standard attribute. |
static float |
getExpTime(Header header)
Returns a reference to the current value of an existing
expTime standard attribute. |
static FloatAttribute |
getExpTimeAttribute(Header header)
Returns a reference to an existing
expTime standard attribute. |
static float |
getFocus(Header header)
Returns a reference to the current value of an existing
focus standard attribute. |
static FloatAttribute |
getFocusAttribute(Header header)
Returns a reference to an existing
focus standard attribute. |
static Rational |
getFramesPerSecond(Header header)
Returns a reference to the current value of an existing
framesPerSecond standard attribute. |
static RationalAttribute |
getFramesPerSecondAttribute(Header header)
Returns a reference to an existing
framesPerSecond standard attribute. |
static float |
getIsoSpeed(Header header)
Returns a reference to the current value of an existing
isoSpeed standard attribute. |
static FloatAttribute |
getIsoSpeedAttribute(Header header)
Returns a reference to an existing
isoSpeed standard attribute. |
static KeyCode |
getKeyCode(Header header)
Returns a reference to the current value of an existing
keyCode standard attribute. |
static KeyCodeAttribute |
getKeyCodeAttribute(Header header)
Returns a reference to an existing
keyCode standard attribute. |
static float |
getLatitude(Header header)
Returns a reference to the current value of an existing
latitude standard attribute. |
static FloatAttribute |
getLatitudeAttribute(Header header)
Returns a reference to an existing
latitude standard attribute. |
static float |
getLongitude(Header header)
Returns a reference to the current value of an existing
longitude standard attribute. |
static FloatAttribute |
getLongitudeAttribute(Header header)
Returns a reference to an existing
longitude standard attribute. |
static String |
getLookModTransform(Header header)
Returns a reference to the current value of an existing
lookModTransform standard attribute. |
static StringAttribute |
getLookModTransformAttribute(Header header)
Returns a reference to an existing
lookModTransform standard attribute. |
static List<String> |
getMultiView(Header header)
Returns a reference to the current value of an existing
multiView standard attribute. |
static StringVectorAttribute |
getMultiViewAttribute(Header header)
Returns a reference to an existing
multiView standard attribute. |
static String |
getOwner(Header header)
Returns a reference to the current value of an existing
owner standard attribute. |
static StringAttribute |
getOwnerAttribute(Header header)
Returns a reference to an existing
owner standard attribute. |
static String |
getRenderingTransform(Header header)
Returns a reference to the current value of an existing
renderingTransform standard attribute. |
static StringAttribute |
getRenderingTransformAttribute(Header header)
Returns a reference to an existing
renderingTransform standard attribute. |
static TimeCode |
getTimeCode(Header header)
Returns a reference to the current value of an existing
timeCode standard attribute. |
static TimeCodeAttribute |
getTimeCodeAttribute(Header header)
Returns a reference to an existing
timeCode standard attribute. |
static float |
getUtcOffset(Header header)
Returns a reference to the current value of an existing
utcOffset standard attribute. |
static FloatAttribute |
getUtcOffsetAttribute(Header header)
Returns a reference to an existing
utcOffset standard attribute. |
static float |
getWhiteLuminance(Header header)
Returns a reference to the current value of an existing
whiteLuminance standard attribute. |
static FloatAttribute |
getWhiteLuminanceAttribute(Header header)
Returns a reference to an existing
whiteLuminance standard attribute. |
static Matrix44<Float> |
getWorldToCamera(Header header)
Returns a reference to the current value of an existing
worldToCamera standard attribute. |
static M44fAttribute |
getWorldToCameraAttribute(Header header)
Returns a reference to an existing
worldToCamera standard attribute. |
static Matrix44<Float> |
getWorldToNDC(Header header)
Returns a reference to the current value of an existing
worldToNDC standard attribute. |
static M44fAttribute |
getWorldToNDCAttribute(Header header)
Returns a reference to an existing
worldToNDC standard attribute. |
static String |
getWrapmodes(Header header)
Returns a reference to the current value of an existing
wrapmodes standard attribute. |
static StringAttribute |
getWrapmodesAttribute(Header header)
Returns a reference to an existing
wrapmodes standard attribute. |
static float |
getXDensity(Header header)
Returns a reference to the current value of an existing
xDensity standard attribute. |
static FloatAttribute |
getXDensityAttribute(Header header)
Returns a reference to an existing
xDensity standard attribute. |
static boolean |
hasAdoptedNeutral(Header header)
Returns
true if header contains the
adoptedNeutral standard attribute. |
static boolean |
hasAltitude(Header header)
Returns
true if header contains the
altitude standard attribute. |
static boolean |
hasAperture(Header header)
Returns
true if header contains the
aperture standard attribute. |
static boolean |
hasCapDate(Header header)
Returns
true if header contains the
capDate standard attribute. |
static boolean |
hasChromaticities(Header header)
Returns
true if header contains the
chromaticities standard attribute. |
static boolean |
hasComments(Header header)
Returns
true if header contains the
comments standard attribute. |
static boolean |
hasEnvMap(Header header)
Returns
true if header contains the
envmap standard attribute. |
static boolean |
hasExpTime(Header header)
Returns
true if header contains the
expTime standard attribute. |
static boolean |
hasFocus(Header header)
Returns
true if header contains the
focus standard attribute. |
static boolean |
hasFramesPerSecond(Header header)
Returns
true if header contains the
framesPerSecond standard attribute. |
static boolean |
hasIsoSpeed(Header header)
Returns
true if header contains the
isoSpeed standard attribute. |
static boolean |
hasKeyCode(Header header)
Returns
true if header contains the
keyCode standard attribute. |
static boolean |
hasLatitude(Header header)
Returns
true if header contains the
latitude standard attribute. |
static boolean |
hasLongitude(Header header)
Returns
true if header contains the
longitude standard attribute. |
static boolean |
hasLookModTransform(Header header)
Returns
true if header contains the
lookModTransform standard attribute. |
static boolean |
hasMultiView(Header header)
Returns
true if header contains the
multiView standard attribute. |
static boolean |
hasOwner(Header header)
Returns
true if header contains the
owner standard attribute. |
static boolean |
hasRenderingTransform(Header header)
Returns
true if header contains the
renderingTransform standard attribute. |
static boolean |
hasTimeCode(Header header)
Returns
true if header contains the
timeCode standard attribute. |
static boolean |
hasUtcOffset(Header header)
Returns
true if header contains the
utcOffset standard attribute. |
static boolean |
hasWhiteLuminance(Header header)
Returns
true if header contains the
whiteLuminance standard attribute. |
static boolean |
hasWorldToCamera(Header header)
Returns
true if header contains the
worldToCamera standard attribute. |
static boolean |
hasWorldToNDC(Header header)
Returns
true if header contains the
worldToNDC standard attribute. |
static boolean |
hasWrapmodes(Header header)
Returns
true if header contains the
wrapmodes standard attribute. |
static boolean |
hasXDensity(Header header)
Returns
true if header contains the
xDensity standard attribute. |
public static void addChromaticities(Header header, Chromaticities value)
chromaticities
standard attribute
to the given header using a non-null value
.header
- a non-null header
value
- the new value of the chromaticities
attributeHeader.insert(String, Attribute)
public static boolean hasChromaticities(Header header)
true
if header
contains the
chromaticities
standard attribute.header
- a non-null Header
true
if header
contains the
chromaticities
standard attributepublic static ChromaticitiesAttribute getChromaticitiesAttribute(Header header)
chromaticities
standard attribute.
If the header does not have a chromaticities
attribute,
that is if header.hasChromaticities()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
chromaticities
standard attributeIllegalArgumentException
- if header
does not have a
chromaticities
standard attributeHeader.getTypedAttribute(String, Class)
public static Chromaticities getChromaticities(Header header)
chromaticities
standard attribute.
If the header does not have a chromaticities
attribute,
that is if header.hasChromaticities()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
chromaticities
standard attributeIllegalArgumentException
- if header
does not have a
chromaticities
standard attributeHeader.getTypedAttribute(String, Class)
public static void addWhiteLuminance(Header header, float value)
whiteLuminance
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the whiteLuminance
attributeHeader.insert(String, Attribute)
public static boolean hasWhiteLuminance(Header header)
true
if header
contains the
whiteLuminance
standard attribute.header
- a non-null Header
true
if header
contains the
whiteLuminance
standard attributepublic static FloatAttribute getWhiteLuminanceAttribute(Header header)
whiteLuminance
standard attribute.
If the header does not have a whiteLuminance
attribute,
that is if header.hasWhiteLuminance()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
whiteLuminance
standard attributeIllegalArgumentException
- if header
does not have a
whiteLuminance
standard attributeHeader.getTypedAttribute(String, Class)
public static float getWhiteLuminance(Header header)
whiteLuminance
standard attribute.
If the header does not have a whiteLuminance
attribute,
that is if header.hasWhiteLuminance()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
whiteLuminance
standard attributeIllegalArgumentException
- if header
does not have a
whiteLuminance
standard attributeHeader.getTypedAttribute(String, Class)
public static void addAdoptedNeutral(Header header, Vector2<Float> value)
adoptedNeutral
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the adoptedNeutral
attributeHeader.insert(String, Attribute)
public static boolean hasAdoptedNeutral(Header header)
true
if header
contains the
adoptedNeutral
standard attribute.header
- a non-null Header
true
if header
contains the
adoptedNeutral
standard attributepublic static V2fAttribute getAdoptedNeutralAttribute(Header header)
adoptedNeutral
standard attribute.
If the header does not have a adoptedNeutral
attribute,
that is if header.hasAdoptedNeutral()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
adoptedNeutral
standard attributeIllegalArgumentException
- if header
does not have a
adoptedNeutral
standard attributeHeader.getTypedAttribute(String, Class)
public static Vector2<Float> getAdoptedNeutral(Header header)
adoptedNeutral
standard attribute.
If the header does not have a adoptedNeutral
attribute,
that is if header.hasAdoptedNeutral()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
adoptedNeutral
standard attributeIllegalArgumentException
- if header
does not have a
adoptedNeutral
standard attributeHeader.getTypedAttribute(String, Class)
public static void addRenderingTransform(Header header, String value)
renderingTransform
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the renderingTransform
attributeHeader.insert(String, Attribute)
public static boolean hasRenderingTransform(Header header)
true
if header
contains the
renderingTransform
standard attribute.header
- a non-null Header
true
if header
contains the
renderingTransform
standard attributepublic static StringAttribute getRenderingTransformAttribute(Header header)
renderingTransform
standard attribute.
If the header does not have a renderingTransform
attribute,
that is if header.hasRenderingTransform()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
renderingTransform
standard attributeIllegalArgumentException
- if header
does not have a
renderingTransform
standard attributeHeader.getTypedAttribute(String, Class)
public static String getRenderingTransform(Header header)
renderingTransform
standard attribute.
If the header does not have a renderingTransform
attribute,
that is if header.hasRenderingTransform()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
renderingTransform
standard attributeIllegalArgumentException
- if header
does not have a
renderingTransform
standard attributeHeader.getTypedAttribute(String, Class)
public static void addLookModTransform(Header header, String value)
lookModTransform
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the lookModTransform
attributeHeader.insert(String, Attribute)
public static boolean hasLookModTransform(Header header)
true
if header
contains the
lookModTransform
standard attribute.header
- a non-null Header
true
if header
contains the
lookModTransform
standard attributepublic static StringAttribute getLookModTransformAttribute(Header header)
lookModTransform
standard attribute.
If the header does not have a lookModTransform
attribute,
that is if header.hasLookModTransform()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
lookModTransform
standard attributeIllegalArgumentException
- if header
does not have a
lookModTransform
standard attributeHeader.getTypedAttribute(String, Class)
public static String getLookModTransform(Header header)
lookModTransform
standard attribute.
If the header does not have a lookModTransform
attribute,
that is if header.hasLookModTransform()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
lookModTransform
standard attributeIllegalArgumentException
- if header
does not have a
lookModTransform
standard attributeHeader.getTypedAttribute(String, Class)
public static void addXDensity(Header header, float value)
xDensity
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the xDensity
attributeHeader.insert(String, Attribute)
public static boolean hasXDensity(Header header)
true
if header
contains the
xDensity
standard attribute.header
- a non-null Header
true
if header
contains the
xDensity
standard attributepublic static FloatAttribute getXDensityAttribute(Header header)
xDensity
standard attribute.
If the header does not have a xDensity
attribute,
that is if header.hasXDensity()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
xDensity
standard attributeIllegalArgumentException
- if header
does not have a
xDensity
standard attributeHeader.getTypedAttribute(String, Class)
public static float getXDensity(Header header)
xDensity
standard attribute.
If the header does not have a xDensity
attribute,
that is if header.hasXDensity()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
xDensity
standard attributeIllegalArgumentException
- if header
does not have a
xDensity
standard attributeHeader.getTypedAttribute(String, Class)
public static void addOwner(Header header, String value)
owner
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the owner
attributeHeader.insert(String, Attribute)
public static boolean hasOwner(Header header)
true
if header
contains the
owner
standard attribute.header
- a non-null Header
true
if header
contains the
owner
standard attributepublic static StringAttribute getOwnerAttribute(Header header)
owner
standard attribute.
If the header does not have a owner
attribute,
that is if header.hasOwner()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
owner
standard attributeIllegalArgumentException
- if header
does not have a
owner
standard attributeHeader.getTypedAttribute(String, Class)
public static String getOwner(Header header)
owner
standard attribute.
If the header does not have a owner
attribute,
that is if header.hasOwner()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
owner
standard attributeIllegalArgumentException
- if header
does not have a
owner
standard attributeHeader.getTypedAttribute(String, Class)
public static void addComments(Header header, String value)
comments
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the comments
attributeHeader.insert(String, Attribute)
public static boolean hasComments(Header header)
true
if header
contains the
comments
standard attribute.header
- a non-null Header
true
if header
contains the
comments
standard attributepublic static StringAttribute getCommentsAttribute(Header header)
comments
standard attribute.
If the header does not have a comments
attribute,
that is if header.hasComments()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
comments
standard attributeIllegalArgumentException
- if header
does not have a
comments
standard attributeHeader.getTypedAttribute(String, Class)
public static String getComments(Header header)
comments
standard attribute.
If the header does not have a comments
attribute,
that is if header.hasComments()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
comments
standard attributeIllegalArgumentException
- if header
does not have a
comments
standard attributeHeader.getTypedAttribute(String, Class)
public static void addCapDate(Header header, String value)
capDate
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the capDate
attributeHeader.insert(String, Attribute)
public static boolean hasCapDate(Header header)
true
if header
contains the
capDate
standard attribute.header
- a non-null Header
true
if header
contains the
capDate
standard attributepublic static StringAttribute getCapDateAttribute(Header header)
capDate
standard attribute.
If the header does not have a capDate
attribute,
that is if header.hasCapDate()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
capDate
standard attributeIllegalArgumentException
- if header
does not have a
capDate
standard attributeHeader.getTypedAttribute(String, Class)
public static String getCapDate(Header header)
capDate
standard attribute.
If the header does not have a capDate
attribute,
that is if header.hasCapDate()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
capDate
standard attributeIllegalArgumentException
- if header
does not have a
capDate
standard attributeHeader.getTypedAttribute(String, Class)
public static void addUtcOffset(Header header, float value)
utcOffset
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the utcOffset
attributeHeader.insert(String, Attribute)
public static boolean hasUtcOffset(Header header)
true
if header
contains the
utcOffset
standard attribute.header
- a non-null Header
true
if header
contains the
utcOffset
standard attributepublic static FloatAttribute getUtcOffsetAttribute(Header header)
utcOffset
standard attribute.
If the header does not have a utcOffset
attribute,
that is if header.hasUtcOffset()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
utcOffset
standard attributeIllegalArgumentException
- if header
does not have a
utcOffset
standard attributeHeader.getTypedAttribute(String, Class)
public static float getUtcOffset(Header header)
utcOffset
standard attribute.
If the header does not have a utcOffset
attribute,
that is if header.hasUtcOffset()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
utcOffset
standard attributeIllegalArgumentException
- if header
does not have a
utcOffset
standard attributeHeader.getTypedAttribute(String, Class)
public static void addCapDateAndUtcOffset(Header header, Date date)
capDate
and utcOffset
standard
attributes to represent the given date (UTC milliseconds since
the Epoch.) in the default time zone for this host. This method is
equivalent to calling:
addCapDateAndUtcOffset(header, date, TimeZone.getDefault())
header
- a non-null header
date
- a given dateNullPointerException
- if either header
or zone
is null
addCapDate(Header, String)
,
addUtcOffset(Header, float)
public static void addCapDateAndUtcOffset(Header header, Date date, TimeZone zone)
capDate
and utcOffset
standard
attributes to represent the given date (UTC milliseconds since
the Epoch.) in a certain time zone.header
- a non-null header
date
- a given datezone
- a given time zoneNullPointerException
- if either header
, date
or zone
is null
addCapDate(Header, String)
,
addUtcOffset(Header, float)
public static Date getCapDateTime(Header header) throws ParseException
Date
instance representing the current value of the
capDate
and utcOffset
standard attributes.
If the header does not have a capDate
attribute,
that is if header.hasCapDate()
is false
,
the method throws IllegalArgumentException
.
If the header does not have a utcOffset
attribute assumes that
capDate
is in the default time zone for this host.
header
- a non-null Header
Date
representing the current value of the
capDate
and utcOffset
standard attributesIllegalArgumentException
- if header
does not have a
capDate
standard attributeParseException
- if capDate
is not in the format
yyyy:MM:dd HH:mm:ss
NullPointerException
- if header
is null
getCapDate(Header)
,
getUtcOffset(Header)
public static void addLongitude(Header header, float value)
longitude
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the longitude
attributeHeader.insert(String, Attribute)
public static boolean hasLongitude(Header header)
true
if header
contains the
longitude
standard attribute.header
- a non-null Header
true
if header
contains the
longitude
standard attributepublic static FloatAttribute getLongitudeAttribute(Header header)
longitude
standard attribute.
If the header does not have a longitude
attribute,
that is if header.hasLongitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
longitude
standard attributeIllegalArgumentException
- if header
does not have a
longitude
standard attributeHeader.getTypedAttribute(String, Class)
public static float getLongitude(Header header)
longitude
standard attribute.
If the header does not have a longitude
attribute,
that is if header.hasLongitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
longitude
standard attributeIllegalArgumentException
- if header
does not have a
longitude
standard attributeHeader.getTypedAttribute(String, Class)
public static void addLatitude(Header header, float value)
latitude
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the latitude
attributeHeader.insert(String, Attribute)
public static boolean hasLatitude(Header header)
true
if header
contains the
latitude
standard attribute.header
- a non-null Header
true
if header
contains the
latitude
standard attributepublic static FloatAttribute getLatitudeAttribute(Header header)
latitude
standard attribute.
If the header does not have a latitude
attribute,
that is if header.hasLatitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
latitude
standard attributeIllegalArgumentException
- if header
does not have a
latitude
standard attributeHeader.getTypedAttribute(String, Class)
public static float getLatitude(Header header)
latitude
standard attribute.
If the header does not have a latitude
attribute,
that is if header.hasLatitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
latitude
standard attributeIllegalArgumentException
- if header
does not have a
latitude
standard attributeHeader.getTypedAttribute(String, Class)
public static void addAltitude(Header header, float value)
altitude
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the altitude
attributeHeader.insert(String, Attribute)
public static boolean hasAltitude(Header header)
true
if header
contains the
altitude
standard attribute.header
- a non-null Header
true
if header
contains the
altitude
standard attributepublic static FloatAttribute getAltitudeAttribute(Header header)
altitude
standard attribute.
If the header does not have a altitude
attribute,
that is if header.hasAltitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
altitude
standard attributeIllegalArgumentException
- if header
does not have a
altitude
standard attributeHeader.getTypedAttribute(String, Class)
public static float getAltitude(Header header)
altitude
standard attribute.
If the header does not have a altitude
attribute,
that is if header.hasAltitude()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
altitude
standard attributeIllegalArgumentException
- if header
does not have a
altitude
standard attributeHeader.getTypedAttribute(String, Class)
public static void addFocus(Header header, float value)
focus
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the focus
attributeHeader.insert(String, Attribute)
public static boolean hasFocus(Header header)
true
if header
contains the
focus
standard attribute.header
- a non-null Header
true
if header
contains the
focus
standard attributepublic static FloatAttribute getFocusAttribute(Header header)
focus
standard attribute.
If the header does not have a focus
attribute,
that is if header.hasFocus()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
focus
standard attributeIllegalArgumentException
- if header
does not have a
focus
standard attributeHeader.getTypedAttribute(String, Class)
public static float getFocus(Header header)
focus
standard attribute.
If the header does not have a focus
attribute,
that is if header.hasFocus()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
focus
standard attributeIllegalArgumentException
- if header
does not have a
focus
standard attributeHeader.getTypedAttribute(String, Class)
public static void addExpTime(Header header, float value)
expTime
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the expTime
attributeHeader.insert(String, Attribute)
public static boolean hasExpTime(Header header)
true
if header
contains the
expTime
standard attribute.header
- a non-null Header
true
if header
contains the
expTime
standard attributepublic static FloatAttribute getExpTimeAttribute(Header header)
expTime
standard attribute.
If the header does not have a expTime
attribute,
that is if header.hasExpTime()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
expTime
standard attributeIllegalArgumentException
- if header
does not have a
expTime
standard attributeHeader.getTypedAttribute(String, Class)
public static float getExpTime(Header header)
expTime
standard attribute.
If the header does not have a expTime
attribute,
that is if header.hasExpTime()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
expTime
standard attributeIllegalArgumentException
- if header
does not have a
expTime
standard attributeHeader.getTypedAttribute(String, Class)
public static void addAperture(Header header, float value)
aperture
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the aperture
attributeHeader.insert(String, Attribute)
public static boolean hasAperture(Header header)
true
if header
contains the
aperture
standard attribute.header
- a non-null Header
true
if header
contains the
aperture
standard attributepublic static FloatAttribute getApertureAttribute(Header header)
aperture
standard attribute.
If the header does not have a aperture
attribute,
that is if header.hasAperture()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
aperture
standard attributeIllegalArgumentException
- if header
does not have a
aperture
standard attributeHeader.getTypedAttribute(String, Class)
public static float getAperture(Header header)
aperture
standard attribute.
If the header does not have a aperture
attribute,
that is if header.hasAperture()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
aperture
standard attributeIllegalArgumentException
- if header
does not have a
aperture
standard attributeHeader.getTypedAttribute(String, Class)
public static void addIsoSpeed(Header header, float value)
isoSpeed
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the isoSpeed
attributeHeader.insert(String, Attribute)
public static boolean hasIsoSpeed(Header header)
true
if header
contains the
isoSpeed
standard attribute.header
- a non-null Header
true
if header
contains the
isoSpeed
standard attributepublic static FloatAttribute getIsoSpeedAttribute(Header header)
isoSpeed
standard attribute.
If the header does not have a isoSpeed
attribute,
that is if header.hasIsoSpeed()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
isoSpeed
standard attributeIllegalArgumentException
- if header
does not have a
isoSpeed
standard attributeHeader.getTypedAttribute(String, Class)
public static float getIsoSpeed(Header header)
isoSpeed
standard attribute.
If the header does not have a isoSpeed
attribute,
that is if header.hasIsoSpeed()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
isoSpeed
standard attributeIllegalArgumentException
- if header
does not have a
isoSpeed
standard attributeHeader.getTypedAttribute(String, Class)
public static void addEnvMap(Header header, EnvMap value)
envmap
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the envmap
attributeHeader.insert(String, Attribute)
public static boolean hasEnvMap(Header header)
true
if header
contains the
envmap
standard attribute.header
- a non-null Header
true
if header
contains the
envmap
standard attributepublic static EnvMapAttribute getEnvMapAttribute(Header header)
envmap
standard attribute.
If the header does not have a envmap
attribute,
that is if header.hasEnvMap()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
envmap
standard attributeIllegalArgumentException
- if header
does not have a
envmap
standard attributeHeader.getTypedAttribute(String, Class)
public static EnvMap getEnvMap(Header header)
envmap
standard attribute.
If the header does not have a envmap
attribute,
that is if header.hasEnvMap()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
envmap
standard attributeIllegalArgumentException
- if header
does not have a
envmap
standard attributeHeader.getTypedAttribute(String, Class)
public static void addKeyCode(Header header, KeyCode value)
keyCode
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the keyCode
attributeHeader.insert(String, Attribute)
public static boolean hasKeyCode(Header header)
true
if header
contains the
keyCode
standard attribute.header
- a non-null Header
true
if header
contains the
keyCode
standard attributepublic static KeyCodeAttribute getKeyCodeAttribute(Header header)
keyCode
standard attribute.
If the header does not have a keyCode
attribute,
that is if header.hasKeyCode()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
keyCode
standard attributeIllegalArgumentException
- if header
does not have a
keyCode
standard attributeHeader.getTypedAttribute(String, Class)
public static KeyCode getKeyCode(Header header)
keyCode
standard attribute.
If the header does not have a keyCode
attribute,
that is if header.hasKeyCode()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
keyCode
standard attributeIllegalArgumentException
- if header
does not have a
keyCode
standard attributeHeader.getTypedAttribute(String, Class)
public static void addTimeCode(Header header, TimeCode value)
timeCode
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the timeCode
attributeHeader.insert(String, Attribute)
public static boolean hasTimeCode(Header header)
true
if header
contains the
timeCode
standard attribute.header
- a non-null Header
true
if header
contains the
timeCode
standard attributepublic static TimeCodeAttribute getTimeCodeAttribute(Header header)
timeCode
standard attribute.
If the header does not have a timeCode
attribute,
that is if header.hasTimeCode()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
timeCode
standard attributeIllegalArgumentException
- if header
does not have a
timeCode
standard attributeHeader.getTypedAttribute(String, Class)
public static TimeCode getTimeCode(Header header)
timeCode
standard attribute.
If the header does not have a timeCode
attribute,
that is if header.hasTimeCode()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
timeCode
standard attributeIllegalArgumentException
- if header
does not have a
timeCode
standard attributeHeader.getTypedAttribute(String, Class)
public static void addWrapmodes(Header header, String value)
wrapmodes
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the wrapmodes
attributeHeader.insert(String, Attribute)
public static boolean hasWrapmodes(Header header)
true
if header
contains the
wrapmodes
standard attribute.header
- a non-null Header
true
if header
contains the
wrapmodes
standard attributepublic static StringAttribute getWrapmodesAttribute(Header header)
wrapmodes
standard attribute.
If the header does not have a wrapmodes
attribute,
that is if header.hasWrapmodes()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
wrapmodes
standard attributeIllegalArgumentException
- if header
does not have a
wrapmodes
standard attributeHeader.getTypedAttribute(String, Class)
public static String getWrapmodes(Header header)
wrapmodes
standard attribute.
If the header does not have a wrapmodes
attribute,
that is if header.hasWrapmodes()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
wrapmodes
standard attributeIllegalArgumentException
- if header
does not have a
wrapmodes
standard attributeHeader.getTypedAttribute(String, Class)
public static void addFramesPerSecond(Header header, Rational value)
framesPerSecond
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the framesPerSecond
attributeHeader.insert(String, Attribute)
public static boolean hasFramesPerSecond(Header header)
true
if header
contains the
framesPerSecond
standard attribute.header
- a non-null Header
true
if header
contains the
framesPerSecond
standard attributepublic static RationalAttribute getFramesPerSecondAttribute(Header header)
framesPerSecond
standard attribute.
If the header does not have a framesPerSecond
attribute,
that is if header.hasFramesPerSecond()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
framesPerSecond
standard attributeIllegalArgumentException
- if header
does not have a
framesPerSecond
standard attributeHeader.getTypedAttribute(String, Class)
public static Rational getFramesPerSecond(Header header)
framesPerSecond
standard attribute.
If the header does not have a framesPerSecond
attribute,
that is if header.hasFramesPerSecond()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
framesPerSecond
standard attributeIllegalArgumentException
- if header
does not have a
framesPerSecond
standard attributeHeader.getTypedAttribute(String, Class)
public static void addMultiView(Header header, List<String> value)
multiView
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the multiView
attributeHeader.insert(String, Attribute)
public static boolean hasMultiView(Header header)
true
if header
contains the
multiView
standard attribute.header
- a non-null Header
true
if header
contains the
multiView
standard attributepublic static StringVectorAttribute getMultiViewAttribute(Header header)
multiView
standard attribute.
If the header does not have a multiView
attribute,
that is if header.hasMultiView()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
multiView
standard attributeIllegalArgumentException
- if header
does not have a
multiView
standard attributeHeader.getTypedAttribute(String, Class)
public static List<String> getMultiView(Header header)
multiView
standard attribute.
If the header does not have a multiView
attribute,
that is if header.hasMultiView()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
multiView
standard attributeIllegalArgumentException
- if header
does not have a
multiView
standard attributeHeader.getTypedAttribute(String, Class)
public static void addWorldToCamera(Header header, Matrix44<Float> value)
worldToCamera
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the worldToCamera
attributeHeader.insert(String, Attribute)
public static boolean hasWorldToCamera(Header header)
true
if header
contains the
worldToCamera
standard attribute.header
- a non-null Header
true
if header
contains the
worldToCamera
standard attributepublic static M44fAttribute getWorldToCameraAttribute(Header header)
worldToCamera
standard attribute.
If the header does not have a worldToCamera
attribute,
that is if header.hasWorldToCamera()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
worldToCamera
standard attributeIllegalArgumentException
- if header
does not have a
worldToCamera
standard attributeHeader.getTypedAttribute(String, Class)
public static Matrix44<Float> getWorldToCamera(Header header)
worldToCamera
standard attribute.
If the header does not have a worldToCamera
attribute,
that is if header.hasWorldToCamera()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
worldToCamera
standard attributeIllegalArgumentException
- if header
does not have a
worldToCamera
standard attributeHeader.getTypedAttribute(String, Class)
public static void addWorldToNDC(Header header, Matrix44<Float> value)
worldToNDC
standard attribute
to the given header using value
.header
- a non-null header
value
- the new value of the worldToNDC
attributeHeader.insert(String, Attribute)
public static boolean hasWorldToNDC(Header header)
true
if header
contains the
worldToNDC
standard attribute.header
- a non-null Header
true
if header
contains the
worldToNDC
standard attributepublic static M44fAttribute getWorldToNDCAttribute(Header header)
worldToNDC
standard attribute.
If the header does not have a worldToNDC
attribute,
that is if header.hasWorldToNDC()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
worldToNDC
standard attributeIllegalArgumentException
- if header
does not have a
worldToNDC
standard attributeHeader.getTypedAttribute(String, Class)
public static Matrix44<Float> getWorldToNDC(Header header)
worldToNDC
standard attribute.
If the header does not have a worldToNDC
attribute,
that is if header.hasWorldToNDC()
is false
,
the method throws IllegalArgumentException
.
header
- a non-null Header
worldToNDC
standard attributeIllegalArgumentException
- if header
does not have a
worldToNDC
standard attributeHeader.getTypedAttribute(String, Class)