FieldsDatabase

class lsst.sims.survey.fields.FieldsDatabase[source]

Bases: object

Initialize the class.

Attributes Summary

FIELDS_DB Internal file containing the standard 3.5 degree FOV survey field information.

Methods Summary

get_field_set(query) Get a set of Field instances.
get_opsim3_userregions(query[, precision]) Get a formatted string of OpSim3 user regions.
get_ra_dec_arrays(query) Retrieve lists of RA and Dec.
get_rows(query) Get the rows from a query.

Attributes Documentation

FIELDS_DB = u'Fields.db'

Internal file containing the standard 3.5 degree FOV survey field information.

Methods Documentation

get_field_set(query)[source]

Get a set of Field instances.

Parameters:

query : str

The query for field retrieval.
Returns:

set

The collection of Field instances.
get_opsim3_userregions(query, precision=2)[source]

Get a formatted string of OpSim3 user regions.

This function gets a formatted string of OpSim3 user regions suitable for an OpSim3 configuration file. The format looks like (RA,Dec,Width):

userRegion = XXX.XX,YYY.YY,0.03 ...

The last column is unused in OpSim3. The precision argument can be used to control the formatting, but OpSim3 configuration files use 2 digits as standard.

Parameters:

query : str

The query for field retrieval.

precision : int, optional

The precision used for the RA and Dec columns. Default is 2.
Returns:

str

The OpSim3 user regions formatted string.
get_ra_dec_arrays(query)[source]

Retrieve lists of RA and Dec.

Parameters:

query : str

The query for field retrieval.
Returns:

numpy.array, numpy.array

The arrays of RA and Dec.
get_rows(query)[source]

Get the rows from a query.

This function hands back all rows from a query. This allows one to perform other operations on the information than those provided by this class.

Parameters:

query : str

The query for field retrieval.
Returns:

list

The set of field information queried.