SIO reading/writing objects (sarpy.io.complex.sio)

Functionality for reading SIO data into a SICD model.

class sarpy.io.complex.sio.SIOReader(sio_details)

Bases: SICDTypeReader

Changed in version 1.3.0 for reading changes.

property sio_details: SIODetails

The sio details object.

Type:

SIODetails

property file_name: str

Defined as a convenience property.

Type:

None|str

close() → None

This should perform any necessary clean-up operations, like closing open file handles, deleting any temp files, etc.

property closed: bool

Is the reader closed? Reading will result in a ValueError

Type:

bool

property data_segment: DataSegment | Tuple[DataSegment, ...]

The data segment collection.

Type:

DataSegment|Tuple[DataSegment, …]

property data_size: Tuple[int, ...] | Tuple[Tuple[int, ...]]

the output/formatted data size(s) of the data segment(s). If there is a single data segment, then this will be Tuple[int, …], otherwise it will be Tuple[Tuple, int, …], …].

Type:

Tuple[int, …]|Tuple[Tuple[int, …], …]

property files_to_delete_on_close: List[str]

A collection of files to delete on the close operation.

Type:

List[str]

get_data_segment_as_tuple() → Tuple[DataSegment, ...]

Get the data segment collection as a tuple, to avoid the need for redundant checking issues.

Return type:

Tuple[DataSegment, …]

get_data_size_as_tuple() → Tuple[Tuple[int, ...], ...]

Get the data size collection as a tuple of tuples, to avoid the need for redundant checking issues.

Return type:

Tuple[Tuple[int, …], …]

get_raw_data_size_as_tuple() → Tuple[Tuple[int, ...], ...]

Get the raw data size collection as a tuple of tuples, to avoid the need for redundant checking issues.

Return type:

Tuple[Tuple[int, …], …]

get_sicd_bands() → Tuple[str, ...]

Gets the list of bands for each sicd.

Return type:

Tuple[str, …]

get_sicd_partitions(match_function: ~typing.Callable = <function is_general_match>) → Tuple[Tuple[int, ...], ...]

Partition the sicd collection into sub-collections according to match_function, which is assumed to establish an equivalence relation.

Parameters:

match_function (callable) – This match function must have call signature (SICDType, SICDType) -> bool, and defaults to sarpy.io.complex.sicd_elements.utils.is_general_match(). This function is assumed reflexive, symmetric, and transitive.

Return type:

Tuple[Tuple[int, …], …]

get_sicd_polarizations() → Tuple[str, ...]

Gets the list of polarizations for each sicd.

Return type:

Tuple[str]

get_sicds_as_tuple() → None | Tuple[SICDType, ...]

Get the sicd or sicd collection as a tuple - for simplicity and consistency of use.

Return type:

None|Tuple[SICDType, …]

property image_count: int

The number of images/data segments from which to read.

Type:

int

property raw_data_size: Tuple[int, ...] | Tuple[Tuple[int, ...]]

the raw data size(s) of the data segment(s). If there is a single data segment, then this will be Tuple[int, …], otherwise it will be Tuple[Tuple, int, …], …].

Type:

Tuple[int, …]|Tuple[Tuple[int, …], …]

read(*ranges: None | int | Tuple[int, ...] | slice, index: int = 0, squeeze: bool = True) → ndarray

Read formatted data from the given data segment. Note this is an alias to the __call__() called as reader(*ranges, index=index, raw=False, squeeze=squeeze).

Parameters:

• ranges (Sequence[Union[None, int, Tuple[int, ...], slice]]) – The slice definition appropriate for data_segment[index].read() usage.

• index (int) – The data_segment index. This is ignored if image_count== 1.

• squeeze (bool) – Squeeze length 1 dimensions out of the shape of the return array?

Return type:

numpy.ndarray

See also

See

meth:sarpy.io.general.data_segment.DataSegment.read.

read_chip(*ranges: Sequence[None | int | Tuple[int, ...] | slice], index: int = 0, squeeze: bool = True) → ndarray

This is identical to read(), and presented for backwards compatibility.

Parameters:

• ranges (Sequence[Union[None, int, Tuple[int, ...], slice]]) –

• index (int) –

• squeeze (bool) –

Return type:

numpy.ndarray

See also

read()

read_raw(*ranges: None | int | Tuple[int, ...] | slice, index: int = 0, squeeze: bool = True) → ndarray

Read raw data from the given data segment. Note this is an alias to the __call__() called as reader(*ranges, index=index, raw=True, squeeze=squeeze).

Parameters:

• ranges (Sequence[Union[None, int, Tuple[int, ...], slice]]) – The slice definition appropriate for data_segment[index].read() usage.

• index (int) – The data_segment index. This is ignored if image_count== 1.

• squeeze (bool) – Squeeze length 1 dimensions out of the shape of the return array?

Return type:

numpy.ndarray

See also

See

meth:sarpy.io.general.data_segment.DataSegment.read_raw.

property reader_type: str

A descriptive string for the type of reader

Type:

str

property sicd_meta: None | SICDType | Tuple[SICDType, ...]

the sicd meta_data or meta_data collection.

Type:

None|SICDType|Tuple[SICDType, …]

sarpy.io.complex.sio.is_a(file_name: str) → SIOReader | None

Tests whether a given file_name corresponds to a SIO file. Returns a reader instance, if so.

Parameters:

file_name (str) – the file_name to check

Returns:

SIOReader instance if SIO file, None otherwise

Return type:

SIOReader|None

class sarpy.io.complex.sio.SIOWriter(file_object: str | BinaryIO, sicd_meta: SICDType, user_data: Dict[str, str] | None = None, check_older_version: bool = False, check_existence: bool = True)

Bases: BaseWriter

Changed in version 1.3.0 for writing changes.

property closed: bool

Is the writer closed? Reading file after writing can result in a ValueError if writer was not closed.

Type:

bool

property data_segment: Tuple[DataSegment, ...]

The data segment collection.

Type:

Tuple[DataSegment, …]

property data_size: Tuple[Tuple[int, ...]]

the formatted data sizes of the data segments.

Type:

Tuple[Tuple[int, …], …]

property image_count: int

The number of overall images/data segments.

Type:

int

property raw_data_size: Tuple[int, ...] | Tuple[Tuple[int, ...]]

the raw data sizes of the data segments.

Type:

Tuple[Tuple[int, …], …]

write(data: ndarray, start_indices: int | Tuple[int, ...] | None = None, subscript: Tuple[slice, ...] | None = None, index: int = 0) → None

Write the data to the appropriate data segment. This is an alias to writer(data, start_indices=start_indices, subscript=subscript, index=index, raw=False).

Only one of `start_indices` and `subscript` should be specified.

Parameters:

• data (numpy.ndarray) – The data to write.

• start_indices (None|int|Tuple[int, ...]) – Assuming a contiguous chunk of data, this provides the starting indices of the chunk. Any missing (tail) coordinates will be filled in with 0’s.

• subscript (None|Tuple[slice, ...]) – In contrast to providing start_indices, the slicing definition in formatted coordinates pertinent to the specified data segment.

• index (int) – The index of the

See also

See

meth:sarpy.io.general.data_segment.DataSegment.write.

write_chip(data: ndarray, start_indices: int | Tuple[int, ...] | None = None, subscript: Tuple[slice, ...] | None = None, index: int = 0) → None

This is identical to write(), and presented for backwards compatibility.

Parameters:

• data (numpy.ndarray) –

• start_indices (None|int|Tuple[int, ...]) –

• subscript (None|Tuple[slice, ...]) –

• index (int) –

See also

See

meth:sarpy.io.general.data_segment.DataSegment.write.

write_raw(data: ndarray, start_indices: int | Tuple[int, ...] | None = None, subscript: Tuple[slice, ...] | None = None, index: int = 0) → None

Write the raw data to the file(s). This is an alias to writer(data, start_indices=start_indices, subscript=subscript, index=index, raw=True).

Only one of `start_indices` and `subscript` should be specified.

Parameters:

• data (numpy.ndarray) – The data to write.

• start_indices (None|int|Tuple[int, ...]) – Assuming a contiguous chunk of data, this provides the starting indices of the chunk. Any missing (tail) coordinates will be filled in with 0’s.

• subscript (None|Tuple[slice, ...]) – In contrast to providing start_indices, the slicing definition in raw coordinates pertinent to the specified data segment.

• index (int) –

See also

See

meth:sarpy.io.general.data_segment.DataSegment.write_raw.

property file_name: str | None

The file name, if feasible.

Type:

None|str

flush(force: bool = False) → None

Try to perform any necessary steps to flush written data to the disk/buffer.

Parameters:

force (bool) – Try force flushing, even for incompletely written data.

Return type:

None

close() → None

Completes any necessary final steps.