![]() |
COMPASS
5.0.0
End-to-end AO simulation tool using GPU acceleration
|
Functions | |
def | variance (f, contributors, method="Default") |
Return the error variance of specified contributors params: f (h5py.File) : roket hdf5 file opened with h5py contributors (list of string) : list of the contributors method (optional, default="Default") : if "Independence", the function returns ths sum of the contributors variances. More... | |
def | varianceMultiFiles (fs, frac_per_layer, contributors) |
Return the variance computed from the sum of contributors of roket files fs, ponderated by frac params: fs (list) : list of hdf5 files opened with h5py frac_per_layer (dict) : frac for each layer contributors (list of string) : list of the contributors return: v (np.array(dim=1)) : variance vector. More... | |
def | cumulativeSR (v, Lambda_tar) |
Returns the cumulative Strehl ratio over the modes from the variance on each mode params: v (np.array(dim=1)) : variance vector return: s (np.array(dim=1)) : cumulative SR. More... | |
def | get_cumSR (filename) |
def | get_Btt (filename) |
def | get_P (filename) |
def | get_contribution (filename, contributor) |
Return the variance of an error contributor. More... | |
def | get_err_contributors (filename, contributors) |
Return the sum of the specified contributors error buffers. More... | |
def | get_err (filename) |
Return the sum of all the error buffers. More... | |
def | get_coverr_independence (filename) |
Return the error covariance matrix considering statistical independence between contributors. More... | |
def | get_coverr_independence_contributors (filename, contributors) |
Return the error covariance matrix considering statistical independence between specified contributors. More... | |
def | get_covmat_contrib (filename, contributors, modal=True) |
Return the covariance matrix of the specified contributors. More... | |
def | get_pup (filename) |
def | get_breakdown (filename) |
Computes the error breakdown in nm rms from a ROKET file. More... | |
def | plotCovCor (filename, maparico=None) |
def | get_IF (filename) |
def | get_mode (filename, n) |
def | get_tar_image (filename) |
Return the PSF computed by COMPASS saved in the ROKET file. More... | |
def | getMap (filename, covmat) |
def | SlopesMap (covmat, filename=None, nssp=None, validint=None) |
def | covFromMap (Map, nsub, filename=None, nssp=None, validint=None) |
def | getCovFromMap (Map, nsub, filename=None, nssp=None, validint=None) |
Return the full spatial representation of a covariance matrix expressed in the slopes space. More... | |
def | get_slopessMap (covmat, filename=None, nssp=None, validint=None) |
Return the full spatial representation of a covariance matrix expressed in the slopes space. More... | |
def | ensquare_PSF (filename, psf, N, display=False, cmap="jet") |
Return the ensquared PSF. More... | |
def | ensquared_energy (filename, psf, N) |
Return the ensquared energy in a box width of N * lambda/D. More... | |
def | cutsPSF (filename, psf, psfs) |
def | compDerivativeCmm (filename=None, slopes=None, dt=1, dd=False, ss=False) |
def | compProfile (filename, nlayers) |
Identify turbulent parameters (wind speed, direction and frac. More... | |
def guardians.drax.compDerivativeCmm | ( | filename = None , |
|
slopes = None , |
|||
dt = 1 , |
|||
dd = False , |
|||
ss = False |
|||
) |
def guardians.drax.compProfile | ( | filename, | |
nlayers | |||
) |
def guardians.drax.covFromMap | ( | Map, | |
nsub, | |||
filename = None , |
|||
nssp = None , |
|||
validint = None |
|||
) |
def guardians.drax.cumulativeSR | ( | v, | |
Lambda_tar | |||
) |
Returns the cumulative Strehl ratio over the modes from the variance on each mode params: v (np.array(dim=1)) : variance vector return: s (np.array(dim=1)) : cumulative SR.
def guardians.drax.cutsPSF | ( | filename, | |
psf, | |||
psfs | |||
) |
def guardians.drax.ensquare_PSF | ( | filename, | |
psf, | |||
N, | |||
display = False , |
|||
cmap = "jet" |
|||
) |
Return the ensquared PSF.
:parameters: filename (str): path to the ROKET file psf (np.ndarray[ndim=2,dtype=np.float32]): PSF to ensquare N (int): size of the square in units of Lambda/D display (bool): (optional) if True, displays also the ensquare PSF cmat (str): (optional) matplotlib colormap to use :return: psf (np.ndarray[ndim=2,dtype=np.float32]): the ensquared psf
Definition at line 776 of file drax.py.
def guardians.drax.ensquared_energy | ( | filename, | |
psf, | |||
N | |||
) |
def guardians.drax.get_breakdown | ( | filename | ) |
Computes the error breakdown in nm rms from a ROKET file.
:parameters: filename (str): path to the ROKET file :return: breakdown (dict): dictionnary containing the error breakdown
def guardians.drax.get_Btt | ( | filename | ) |
def guardians.drax.get_contribution | ( | filename, | |
contributor | |||
) |
Return the variance of an error contributor.
:parameters: filename (str): path to the ROKET file contributor (str): contributor name :return: v (np.array[ndim=1, dtype=np.float32]): variance of the contributor
def guardians.drax.get_coverr_independence | ( | filename | ) |
def guardians.drax.get_coverr_independence_contributors | ( | filename, | |
contributors | |||
) |
Return the error covariance matrix considering statistical independence between specified contributors.
:parameters: filename (str): path to the ROKET file contributors (list): list of contributors :return: err (np.ndarray[ndim=2,dtype=np.float32]): Covariance matrix
def guardians.drax.get_covmat_contrib | ( | filename, | |
contributors, | |||
modal = True |
|||
) |
Return the covariance matrix of the specified contributors.
:parameters: filename (str): path to the ROKET file contributor (list): name of a contributor of the ROKET file modal (bool): if True (default), return the matrix expressed in the modal basis :return: covmat (np.ndarray(ndim=2, dtype=np.float32)): covariance matrix
Definition at line 266 of file drax.py.
def guardians.drax.get_err | ( | filename | ) |
def guardians.drax.get_err_contributors | ( | filename, | |
contributors | |||
) |
Return the sum of the specified contributors error buffers.
:parameters: filename (str): path to the ROKET file contributors (list): list of contributors :return: err (np.ndarray[ndim=2,dtype=np.float32]): Sum of the error buffers
def guardians.drax.get_IF | ( | filename | ) |
def guardians.drax.get_mode | ( | filename, | |
n | |||
) |
def guardians.drax.get_P | ( | filename | ) |
def guardians.drax.get_slopessMap | ( | covmat, | |
filename = None , |
|||
nssp = None , |
|||
validint = None |
|||
) |
Return the full spatial representation of a covariance matrix expressed in the slopes space.
:parameters: covmat (np.ndarray[ndim=2,dtype=np.float32]): part of the covariance matrix filename (str): (optional) path to the ROKET file nssp (int): (optional) Number of ssp in the diameter validint (float): (optional) Central obstruction as a ratio of D :return: Map (np.ndarray[ndim=2,dtype=np.float32]): covariance map
Definition at line 743 of file drax.py.
def guardians.drax.get_tar_image | ( | filename | ) |
def guardians.drax.getCovFromMap | ( | Map, | |
nsub, | |||
filename = None , |
|||
nssp = None , |
|||
validint = None |
|||
) |
Return the full spatial representation of a covariance matrix expressed in the slopes space.
:parameters: covmat (np.ndarray[ndim=2,dtype=np.float32]): part of the covariance matrix filename (str): (optional) path to the ROKET file nssp (int): (optional) Number of ssp in the diameter validint (float): (optional) Central obstruction as a ratio of D :return: Map (np.ndarray[ndim=2,dtype=np.float32]): covariance map
Definition at line 712 of file drax.py.
def guardians.drax.getMap | ( | filename, | |
covmat | |||
) |
def guardians.drax.SlopesMap | ( | covmat, | |
filename = None , |
|||
nssp = None , |
|||
validint = None |
|||
) |
def guardians.drax.variance | ( | f, | |
contributors, | |||
method = "Default" |
|||
) |
Return the error variance of specified contributors params: f (h5py.File) : roket hdf5 file opened with h5py contributors (list of string) : list of the contributors method (optional, default="Default") : if "Independence", the function returns ths sum of the contributors variances.
If "Default", it returns the variance of the contributors sum
Definition at line 23 of file drax.py.
def guardians.drax.varianceMultiFiles | ( | fs, | |
frac_per_layer, | |||
contributors | |||
) |
Return the variance computed from the sum of contributors of roket files fs, ponderated by frac params: fs (list) : list of hdf5 files opened with h5py frac_per_layer (dict) : frac for each layer contributors (list of string) : list of the contributors return: v (np.array(dim=1)) : variance vector.
Definition at line 54 of file drax.py.