orsopy.fileio.reduction
The reduction elements for the ORSO header
- class orsopy.fileio.reduction.Software(name, version=None, platform=None, comment=None)[source]
Bases:
Header
Software description.
- Parameters:
name (
str
) – Software name.version (
Optional
[str
]) – Version identified for the software.platform (
Optional
[str
]) – Operating system.
-
name:
str
-
version:
Optional
[str
] = None
-
platform:
Optional
[str
] = None
- yaml_representer(dumper)
-
comment:
Optional
[str
] = None
- class orsopy.fileio.reduction.Reduction(software, timestamp=None, creator=None, corrections=None, computer=None, call=None, script=None, binary=None, comment=None)[source]
Bases:
Header
A description of the reduction that has been performed.
- Parameters:
software (
Software
) – Software used for reduction.timestamp (
Optional
[datetime
]) – Datetime of reduced file creation.creator (
Optional
[Person
]) – The person or routine who created the reduced file.corrections (
Optional
[List
[str
]]) – A list of the corrections that have been performed.computer (
Optional
[str
]) – Name of the reduction machine.call (
Optional
[str
]) – Command line call or similar.script (
Optional
[str
]) – Path to reduction script or notebook.binary (
Optional
[str
]) – Path to full reduction information file.
-
timestamp:
Optional
[datetime
] = None
-
corrections:
Optional
[List
[str
]] = None
-
computer:
Optional
[str
] = None
-
call:
Optional
[str
] = None
-
script:
Optional
[str
] = None
-
binary:
Optional
[str
] = None
-
comment:
Optional
[str
] = None