Skip to content

Documentation for VisibleSim

Bases: Sim

get_FFI(nreads=50, noise=True)

Get a single frame of data as an FFI

Returns:

data : np.ndarray Returns a single FFI as a numpy array with dtype uint32.

observe(nreads=50, nframes=100, start_time=Time('2000-01-01T12:00:00', scale='utc'), target_flux_function=None, noise=True, jitter=True, output_type='fits', bin_frames=10)

Returns an observation as though taken from the Pandora Observatory.

Parameters:

Returns:

result : np.ndarray or astropy.io.fits.HDUList Result of the simulation. Either a numpy array with shape (nROIs, nframes, nrows, ncolumns), or a fits format.

point(ra, dec, roll)

Point the simulation in a direction.

select_ROI_corners(nROIs, magnitude_limit=14)

Selects the corners of ROIs.

This is currently a placeholder. SOC will provide direction on how ROIs will be selected.

Parameters:

magnitude_limit : float Visual magnitude limit down to which ROI targets will be considered.

show_FFI(ax=None)

Plot an example of an FFI.

show_ROI()

Plot an example of an ROI.