The SIDD 2.0 Display object¶

The ProductDisplayType definition.

class sarpy.io.product.sidd2_elements.Display.BandLUTType(Predefined=None, Custom=None, k=None, **kwargs)¶

Bases: NewLookupTableType

k¶

The array index. Must be in the range [1, 4294967296] Required.

Type:: int

Custom: CustomLookupType¶

Optional.

Type:: CustomLookupType

LUTName: str¶

The lookup table name Required.

Type:: str

Predefined: PredefinedLookupType¶

Optional.

Type:: PredefinedLookupType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.BandEqualizationType(Algorithm='1DLUT', BandLUTs=None, **kwargs)¶

Bases: Serializable

Algorithm: str¶

The algorithm type. Takes values in ('1DLUT',). Default value is 1DLUT. Required.

Type:: str

BandLUTs: BandLUTArray | List[BandLUTType]¶

Must have length <= 0. Required.

Type:: numpy.ndarray[BandLUTType]

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.ProductGenerationOptionsType(BandEqualization=None, ModularTransferFunctionRestoration=None, DataRemapping=None, **kwargs)¶

Bases: Serializable

AsymmetricPixelCorrection: FilterType¶

The asymmetric pixel correction. Optional.

Type:: FilterType

BandEqualization: BandEqualizationType¶

Band equalization ensures that real-world neutral colors have equal digital count values (i.e. are represented as neutral colors) across the dynamic range of the imaged scene. Optional.

Type:: BandEqualizationType

ModularTransferFunctionRestoration: FilterType¶

If present, the filter must not exceed \(15 \times 15\). Optional.

Type:: FilterType

DataRemapping: NewLookupTableType¶

Data remapping refers to the specific need to convert the data of incoming, expanded or uncompressed image band data to non-mapped image data. Required.

Type:: NewLookupTableType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.RRDSType(DownsamplingMethod=None, AntiAlias=None, Interpolation=None, **kwargs)¶

Bases: Serializable

RRDS type.

DownsamplingMethod: str¶

Algorithm used to perform RRDS downsampling Takes values in ('DECIMATE', 'MAX PIXEL', 'AVERAGE', 'NEAREST NEIGHBOR', 'BILINEAR', 'LAGRANGE'). Required.

Type:: str

AntiAlias: FilterType¶

The anti-aliasing filter. Should only be included if DownsamplingMethod= “DECIMATE” Optional.

Type:: FilterType

Interpolation: FilterType¶

The interpolation filter. Should only be included if DownsamplingMethod= “DECIMATE” Optional.

Type:: FilterType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.NonInteractiveProcessingType(ProductGenerationOptions=None, RRDS=None, band=1, **kwargs)¶

Bases: Serializable

The non-interactive processing information.

ProductGenerationOptions: ProductGenerationOptionsType¶

Performs several key actions on an image to prepare it for necessary additional processing to achieve the desired output product. Required.

Type:: ProductGenerationOptionsType

RRDS: RRDSType¶

Creates a set of sub-sampled versions of an image to provide processing chains with quick access to lower magnification values for faster computation speeds and performance. Required.

Type:: RRDSType

band: int¶

The image band to which this applies. Required.

Type:: int

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.ScalingType(AntiAlias=None, Interpolation=None, **kwargs)¶

Bases: Serializable

Scaling for geometric transformation

AntiAlias: FilterType¶

The Anti-Alias Filter used for scaling. Refer to program-specific documentation for population guidance. Required.

Type:: FilterType

Interpolation: FilterType¶

The Interpolation Filter used for scaling. Refer to program-specific documentation for population guidance. Required.

Type:: FilterType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.OrientationType(ShadowDirection='DOWN', **kwargs)¶

Bases: Serializable

Parameters describing the default orientation of the product.

ShadowDirection: str¶

Describes the shadow direction relative to the pixels in the file. Takes values in ('UP', 'DOWN', 'LEFT', 'RIGHT', 'ARBITRARY'). Default value is DOWN. Required.

Type:: str

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.GeometricTransformType(Scaling=None, Orientation=None, **kwargs)¶

Bases: Serializable

The geometric transform element is used to perform various geometric distortions to each band of image data. These distortions include image chipping, scaling, rotation, shearing, etc.

Scaling: ScalingType¶

The scaling filters. Required.

Type:: ScalingType

Orientation: OrientationType¶

Parameters describing the default orientation of the product. Required.

Type:: OrientationType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.SharpnessEnhancementType(ModularTransferFunctionCompensation=None, ModularTransferFunctionEnhancement=None, **kwargs)¶

Bases: Serializable

Sharpness enhancement filter parameters.

ModularTransferFunctionCompensation: FilterType¶

If defining a custom Filter, it must be no larger than \(5\times 5\). Optional.

Type:: FilterType

ModularTransferFunctionEnhancement: FilterType¶

If defining a custom Filter, it must be no larger than \(5\times 5\). Optional.

Type:: FilterType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.ColorManagementModuleType(RenderingIntent='PERCEPTUAL', SourceProfile=None, DisplayProfile=None, ICCProfile=None, **kwargs)¶

Bases: Serializable

Parameters describing the Color Management Module (CMM).

RenderingIntent: str¶

The rendering intent for this color management. Takes values in ('PERCEPTUAL', 'SATURATION', 'RELATIVE', 'ABSOLUTE'). Default value is PERCEPTUAL. Required.

Type:: str

SourceProfile: str¶

Name of sensor profile in ICC Profile database. Required.

Type:: str

DisplayProfile: str¶

Name of display profile in ICC Profile database. Optional.

Type:: str

ICCProfile: str¶

Valid ICC profile signature. Optional.

Type:: str

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.ColorSpaceTransformType(ColorManagementModule=None, **kwargs)¶

Bases: Serializable

Parameters describing any color transformation.

ColorManagementModule: ColorManagementModuleType¶

Parameters describing the Color Management Module (CMM). Required.

Type:: ColorManagementModuleType

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.DRAParametersType(Pmin=None, Pmax=None, EminModifier=None, EmaxModifier=None, **kwargs)¶

Bases: Serializable

The basic dynamic range adjustment parameters.

Pmin: float¶

DRA clip low point. This is the cumulative histogram percentage value that defines the lower end-point of the dynamic range to be displayed. Must be in the range [0, 1] Required.

Type:: float

Pmax: float¶

DRA clip high point. This is the cumulative histogram percentage value that defines the upper end-point of the dynamic range to be displayed. Must be in the range [0, 1] Required.

Type:: float

EminModifier: float¶

The pixel value corresponding to the Pmin percentage point in the image histogram. Must be in the range [0, 1] Required.

Type:: float

EmaxModifier: float¶

The pixel value corresponding to the Pmax percentage point in the image histogram. Must be in the range [0, 1] Required.

Type:: float

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.DRAOverridesType(Subtractor=None, Multiplier=None, **kwargs)¶

Bases: Serializable

The dynamic range adjustment overrides.

Subtractor: float¶

Subtractor value used to reduce haze in the image. Must be in the range [0, 2047] Required.

Type:: float

Multiplier: float¶

Multiplier value used to reduce haze in the image. Must be in the range [0, 2047] Required.

Type:: float

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.Display.DynamicRangeAdjustmentType(AlgorithmType='NONE', BandStatsSource=None, DRAParameters=None, DRAOverrides=None, **kwargs)¶

Bases: Serializable

The dynamic range adjustment (DRA) parameters.

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

AlgorithmType: str¶

Algorithm used for dynamic range adjustment. Takes values in ('AUTO', 'MANUAL', 'NONE'). Default value is NONE. Required.

Type:: str

BandStatsSource: int¶

Required.

Type:: int

DRAParameters: DRAParametersType¶

The dynamic range adjustment parameters. Optional.

Type:: DRAParametersType

DRAOverrides: DRAOverridesType¶

The dynamic range adjustment overrides. Optional.

Type:: DRAOverridesType

class sarpy.io.product.sidd2_elements.Display.InteractiveProcessingType(GeometricTransform=None, SharpnessEnhancement=None, ColorSpaceTransform=None, DynamicRangeAdjustment=None, band=1, **kwargs)¶

Bases: Serializable

The interactive processing information.

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

TonalTransferCurve: NewLookupTableType¶

The 1-D LUT element uses one or more 1-D LUTs to stretch or compress tone data in valorous regions within a digital image’s dynamic range. 1-D LUT can be implemented using a Tonal Transfer Curve (TTC). There are 12 families of TTCs - Range = [0, 11]. There are 64 members for each family - Range=[0, 63]. Optional.

Type:: NewLookupTableType

GeometricTransform: GeometricTransformType¶

The geometric transform element is used to perform various geometric distortions to each band of image data. These distortions include image chipping, scaling, rotation, shearing, etc. Required.

Type:: GeometricTransformType

SharpnessEnhancement: SharpnessEnhancementType¶

Sharpness enhancement. Required.

Type:: SharpnessEnhancementType

ColorSpaceTransform: ColorSpaceTransformType¶

Color space transform. Optional.

Type:: ColorSpaceTransformType

DynamicRangeAdjustment: DynamicRangeAdjustmentType¶

Specifies the recommended ELT DRA overrides. Required.

Type:: DynamicRangeAdjustmentType

band¶

The image band to which this applies. Required.

Type:: int

class sarpy.io.product.sidd2_elements.Display.ProductDisplayType(PixelType=None, NumBands=1, DefaultBandDisplay=None, NonInteractiveProcessing=None, InteractiveProcessing=None, DisplayExtensions=None, **kwargs)¶

Bases: Serializable

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)¶

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())¶

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())¶

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)¶

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

PixelType: str¶

Enumeration of the pixel type. Definition in Design and Exploitation document. Takes values in ('MONO8I', 'MONO8LU', 'MONO16I', 'RGB8LU', 'RGB24I'). Required.

Type:: str

NumBands: int¶

Number of bands contained in the image. Populate with the number of bands present after remapping. For example an 8-bit RGB image (RGBLU), this will be 3. Required.

Type:: int

DefaultBandDisplay: int¶

Indicates which band to display by default. Valid range = 1 to NumBands. Optional.

Type:: int

NonInteractiveProcessing: List[NonInteractiveProcessingType]¶

Non-interactive processing details. Required.

Type:: List[NonInteractiveProcessingType]

InteractiveProcessing: List[InteractiveProcessingType]¶

Interactive processing details. Required.

Type:: List[InteractiveProcessingType]

DisplayExtensions: ParametersCollection¶

Optional extensible parameters used to support profile-specific needs related to product display. Predefined filter types. Optional.

Type:: ParametersCollection

get_pixel_size() → int¶

Gets the raw size per pixel, in bytes.

Return type:: int

The SIDD 2.0 Display object¶

Table of Contents

Previous topic

Next topic

This Page