Instrument

class erwans3.Instrument_class.Instrument(telescope: SatCoord, spec_mode: Optional[str] = None)

Bases: object

Main class used to run instrumental simulations. It contains: - the antennas true trajectory (position, velocity, attitude over time) - the instrument properties (specifications) - a list of acquisition request (to simulate) - a list of true acquisition (output of simulation)

• the antennas knwown trajectory (with error)

• a list of knwown acquisition (with error)

Usage: 1) define the instrument - trajectories as |SatCoord| - properties as |SpecificationParameters| 2) define the aquisition request as |AcquisitionRequest| 3) run method ‘simulate_acq’ run perform the simulation. 4) optional: add errors ((method to be defined))

Parameters:

telescopeSatCoord

The true trajectory of the antennas (position, velocity, attitude over time).

spec_mode:obj:str, optional

Mode for instrument specifications.

Methods:

change_spec():

Change a value in the Specs of the instrument.

add_acquisition_request():

Add an acquisition request to the request_list of the instrument.

remove_acquisition_request():

Remove an acquisition request from the request_list of the instrument.

clear_acquisition_list():

Empty the request_list of the instrument.

Attributes Summary

Swarm

Get the Swarm object representing antennas' true trajectory.

Methods Summary

add_acquisition_request(Acq_req)	Add an acquisition request to the request_list of the instrument
change_spec(name, val)	Change a value in the Specs of the instrument
clear_aquisition_list()	Empty the request_list of the instrument
remove_acquisiton_request(idx_acq_req)	Remove an acquisition request to the request_list of the instrument
simulate_acq(sky_simu[, idx_acq])	Main method to run simulations Run the acquisitions requested in the attribute 'request_list' Add the result in the attribute 'acquisition_list
simulate_single_acq(skysimu, acqreq)	Run the simulation associated with a single acquisition request.

Attributes Documentation

Swarm

Get the Swarm object representing antennas’ true trajectory.

Returns:

SatCoord

The antennas’ true trajectory (position, velocity, attitude over time).

Methods Documentation

add_acquisition_request(Acq_req: AcquisitionRequest)

Add an acquisition request to the request_list of the instrument

Parameters:

Acq_reqAcquisitionRequest

The type of acquisition request to add.

change_spec(name: str, val: Any)

Change a value in the Specs of the instrument

Parameters:

namestr

The name of the specification parameter to change.

valAny

The new value for the specification parameter.

Returns:

Instrument

The Instrument object after changing the specification.

clear_aquisition_list()

Empty the request_list of the instrument

remove_acquisiton_request(idx_acq_req: int)

Remove an acquisition request to the request_list of the instrument

Parameters:

idx_acq_reqint

The index of the acquisition request to remove.

simulate_acq(sky_simu: SkyModel, idx_acq: Optional[Union[str, int, ndarray]] = None)

Main method to run simulations Run the acquisitions requested in the attribute ‘request_list’ Add the result in the attribute ‘acquisition_list

simulate_single_acq(skysimu: SkyModel, acqreq: AcquisitionRequest)

Run the simulation associated with a single acquisition request.

Parameters:

skysimuSkyModel

The sky model used for simulation.

acqreqAcquisitionRequest

The type of acquisition request to simulate.

Returns:

Any

The measurement set resulting from the simulation.