s1tiling.libs.steps.StoreStep

class s1tiling.libs.steps.StoreStep(previous: _OTBStep)[source]

Bases: _ProducerStep

Artificial Step that takes care of executing the last OTB application in the pipeline.

New methods & Specialized methods

__init__

Constructor.

_do_call_hook

Specializes hook execution in case of OTB applications: we also pass the otb application.

_do_execute

Takes care of positionning the out parameter of the OTB applications pipeline, and trigger the execution of the (in-memory, or not) pipeline.

_set_out_parameters

Takes care of setting all output parameters.

release_app

Makes sure that steps with applications are releasing the application (no-op for this class)

Methods inherited from parent

execute_and_write_output

Actually produce the expected output.

Attributes and properties

basename

Basename property will be used to generate all future output filenames.

is_first_step

Tells whether this step is the first of a pipeline.

meta

Step meta data property.

out_filename

Property that returns the name of the file produced by the current step.

pipeline_name

Generate a name for the associated pipeline

shall_store

No OTB related step requires its result to be stored on disk and to break in_memory connection by default.

tmp_filename

Property that returns the name of the file produced by the current step while the OTB application, or the executable, or even the gdal function is running.

_do_call_hook(hook: Callable) None[source]

Specializes hook execution in case of OTB applications: we also pass the otb application.

_do_execute(parameters, dryrun: bool) None[source]

Takes care of positionning the out parameter of the OTB applications pipeline, and trigger the execution of the (in-memory, or not) pipeline.

property basename: str

Basename property will be used to generate all future output filenames.

execute_and_write_output(parameters, execution_parameters: Dict) None

Actually produce the expected output. The how is still a variation point that’ll get decided in _do_execute() specializations.

While the output is produced, a temporary filename will be used as output. On successful execution, the output will be renamed to match its expected final name.

property is_first_step: bool

Tells whether this step is the first of a pipeline.

property meta: Dict

Step meta data property.

property out_filename: str

Property that returns the name of the file produced by the current step.

property pipeline_name

Generate a name for the associated pipeline

release_app() None[source]

Makes sure that steps with applications are releasing the application (no-op for this class)

property shall_store: bool

No OTB related step requires its result to be stored on disk and to break in_memory connection by default.

However, the artificial Step produced by Store factory will force the result of the previous application(s) to be stored on disk.

property tmp_filename: str

Property that returns the name of the file produced by the current step while the OTB application, or the executable, or even the gdal function is running. Eventually, it’ll get renamed into self.out_filename if the application succeeds.