lsst.scarlet.lite.io.cube_component Namespace Reference

Classes
class	ComponentCube
class	ScarletCubeComponentData

Functions
dict	_to_1_0_0 (dict data)

Variables
str	CURRENT_SCHEMA = "1.0.0"
str	COMPONENT_TYPE = "cube"

Function Documentation

_to_1_0_0()

dict lsst.scarlet.lite.io.cube_component._to_1_0_0 ( dict data )

protected

Migrate a pre-schema CubeComponent to schema version 1.0.0

There were no changes to this data model in v1.0.0 but we need
to provide a way to migrate pre-schema data.

Parameters
----------
data :
    The data to migrate.

Returns
-------
result :
    The migrated data.

Definition at line 185 of file cube_component.py.

def _to_1_0_0(data: dict) -> dict:
    """Migrate a pre-schema CubeComponent to schema version 1.0.0
 
    There were no changes to this data model in v1.0.0 but we need
    to provide a way to migrate pre-schema data.
 
    Parameters
    ----------
    data :
        The data to migrate.
 
    Returns
    -------
    result :
        The migrated data.
    """
    data["version"] = "1.0.0"
    return data

Variable Documentation

COMPONENT_TYPE

str lsst.scarlet.lite.io.cube_component.COMPONENT_TYPE = "cube"

Definition at line 19 of file cube_component.py.

CURRENT_SCHEMA

str lsst.scarlet.lite.io.cube_component.CURRENT_SCHEMA = "1.0.0"

Definition at line 18 of file cube_component.py.