TiffData¶
Bases: NBOBaseClass
Represents the XML element TiffData.
This field describes the location of the pixel data in a tiff file.
fromBase(base)
staticmethod
¶
Cast a NBOBaseClass to a CMOS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base
|
NBOBaseClass
|
The base class to cast |
required |
Returns:
| Type | Description |
|---|---|
TiffData
|
The casted element, or nullptr if the cast fails |
getTypeName()
¶
Returns the class type name.
Returns:
| Type | Description |
|---|---|
string
|
The class type name |
getXMLName()
¶
Returns the XML element name corresponding to this class.
Returns:
| Type | Description |
|---|---|
string
|
The XML element name |
getNBOType()
¶
Returns the NBO Type corresponding to this class.
Returns:
| Type | Description |
|---|---|
int
|
The NBO Type value |
getChildren()
¶
Returns a list of all classes derived from this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of derived classes |
getSubElements()
¶
Returns a list of all child elements contained in this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of child classes |
fromJsonFile(path, validate=True)
¶
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromJsonString(json_string, validate=True)
¶
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromXmlFile(path, validate=True)
¶
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromXmlString(xml_string, validate=True)
¶
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
toXmlFile(filename, validate=True)
¶
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
toXmlString(validate=True)
¶
Serializes this object to an XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setIFD(value, validate=True)
¶
Sets the value of the IFD attribute.
Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIFD()
¶
Returns the value of the IFD attribute.
Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]
Returns:
| Type | Description |
|---|---|
NonNegativeInt_Type
|
The value of the attribute |
resetIFD()
¶
Resets the IFD attribute to an unset state.
Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]
hasIFD()
¶
Checks whether the optional IFD attribute is present.
Gives the IFD(s) for which this element is applicable. Indexed from 0. Default is 0 (the first IFD). [units:none]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setFirstZ(value, validate=True)
¶
Sets the value of the FirstZ attribute.
Gives the Z position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getFirstZ()
¶
Returns the value of the FirstZ attribute.
Gives the Z position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]
Returns:
| Type | Description |
|---|---|
NonNegativeInt_Type
|
The value of the attribute |
resetFirstZ()
¶
Resets the FirstZ attribute to an unset state.
Gives the Z position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]
hasFirstZ()
¶
Checks whether the optional FirstZ attribute is present.
Gives the Z position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first Z position). [units:none]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setFirstT(value, validate=True)
¶
Sets the value of the FirstT attribute.
Gives the T position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getFirstT()
¶
Returns the value of the FirstT attribute.
Gives the T position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]
Returns:
| Type | Description |
|---|---|
NonNegativeInt_Type
|
The value of the attribute |
resetFirstT()
¶
Resets the FirstT attribute to an unset state.
Gives the T position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]
hasFirstT()
¶
Checks whether the optional FirstT attribute is present.
Gives the T position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first T position). [units:none]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setFirstC(value, validate=True)
¶
Sets the value of the FirstC attribute.
Gives the C position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getFirstC()
¶
Returns the value of the FirstC attribute.
Gives the C position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]
Returns:
| Type | Description |
|---|---|
NonNegativeInt_Type
|
The value of the attribute |
resetFirstC()
¶
Resets the FirstC attribute to an unset state.
Gives the C position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]
hasFirstC()
¶
Checks whether the optional FirstC attribute is present.
Gives the C position of the Image Plane at the specified IFD. Indexed from 0. Default is 0 (the first C position). [units:none]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setPlaneCount(value, validate=True)
¶
Sets the value of the PlaneCount attribute.
Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getPlaneCount()
¶
Returns the value of the PlaneCount attribute.
Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]
Returns:
| Type | Description |
|---|---|
NonNegativeInt_Type
|
The value of the attribute |
resetPlaneCount()
¶
Resets the PlaneCount attribute to an unset state.
Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]
hasPlaneCount()
¶
Checks whether the optional PlaneCount attribute is present.
Gives the number of IFDs affected. Dimension order of IFDs is given by the enclosing Pixels element's DimensionOrder attribute. Default is the number of IFDs in the TIFF file, unless an IFD is specified, in which case the default is 1. [units:none]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setUUID(value, validate=True)
¶
Sets the value of the UUID element.
This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TiffData_InlineUUID
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getUUID()
¶
Returns the value of the UUID element.
This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.
Returns:
| Type | Description |
|---|---|
TiffData_InlineUUID
|
The value of the element |
resetUUID()
¶
Resets the UUID element to an unset state.
This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.
hasUUID()
¶
Checks whether the optional UUID element is present.
This must be used when the IFDs are located in another file. Note: It is permissible for this to be self referential.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |