shesha.constants Namespace Reference

Numerical constants for shesha and config enumerations for safe-typing. More...

Classes
class	ApertureType
	Telescope apertures. More...
class	CentroiderFctType
class	CentroiderType
	Centroider types. More...
class	CONST
class	ControllerType
	Controller types. More...
class	DmType
	Types of deformable mirrors. More...
class	FieldStopType
	WFS field stop. More...
class	InfluType
	Influence function types. More...
class	KLType
	Possible KLs for computations. More...
class	PatternType
	Types of Piezo DM patterns. More...
class	ProfType
	Sodium profile for LGS. More...
class	PyrCentroiderMethod
class	SpiderType
	Spiders. More...
class	TargetImageType
	Target Images. More...
class	WFSType
	WFS Types. More...

Functions
def	check_enum (cls, name)
	Create a safe-type enum instance from bytes contents. More...

Detailed Description

Numerical constants for shesha and config enumerations for safe-typing.

Author

COMPASS Team https://github.com/ANR-COMPASS

Version

5.0.0

Date

2020/05/18

Copyright

GNU Lesser General Public License

This file is part of COMPASS https://anr-compass.github.io/compass/

Copyright (C) 2011-2019 COMPASS Team https://github.com/ANR-COMPASS All rights reserved. Distributed under GNU - LGPL

COMPASS is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

COMPASS: End-to-end AO simulation tool using GPU acceleration The COMPASS platform was designed to meet the need of high-performance for the simulation of AO systems.

The final product includes a software package for simulating all the critical subcomponents of AO, particularly in the context of the ELT and a real-time core based on several control approaches, with performances consistent with its integration into an instrument. Taking advantage of the specific hardware architecture of the GPU, the COMPASS tool allows to achieve adequate execution speeds to conduct large simulation campaigns called to the ELT.

The COMPASS platform can be used to carry a wide variety of simulations to both testspecific components of AO of the E-ELT (such as wavefront analysis device with a pyramid or elongated Laser star), and various systems configurations such as multi-conjugate AO.

COMPASS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with COMPASS. If not, see https://www.gnu.org/licenses/lgpl-3.0.txt.

Function Documentation

check_enum()

def shesha.constants.check_enum	(		cls,
			name
	)

Create a safe-type enum instance from bytes contents.

Definition at line 51 of file constants.py.

    """
 
    if not isinstance(name, str) or \
            not name in vars(cls).values():
        raise ValueError("Invalid enumeration value for enum %s, value %s" % (cls, name))
    return name