SkyPlot¶
- class lsst.analysis.tools.actions.plot.SkyPlot(*args, **kw)¶
Bases:
PlotAction
Plots the on sky distribution of a parameter.
Plots the values of the parameter given for the z axis according to the positions given for x and y. Optimised for use with RA and Dec. Also calculates some basic statistics and includes those on the plot.
Attributes Summary
Apply a
Context
to anAnalysisAction
recursively.Fix the colorbar to be symmetric around zero.
If a configurable action is assigned to a
ConfigurableActionField
, or aConfigurableActionStructField
the name of the field will be bound to this variable when it is retrieved.The name for the plot.
Plot the outlines of the ccds/patches? (
bool
, defaultTrue
)Selection of types of objects to plot.
Label to use for the x axis.
Label to use for the y axis.
Label to use for the z axis.
Methods Summary
__call__
(data, **kwargs)Call self as a function.
addInputSchema
(inputSchema)Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to
getInputSchema
.compare
(other[, shortcut, rtol, atol, output])Compare this configuration to another
Config
for equality.formatHistory
(name, **kwargs)Format a configuration field's history to a human-readable format.
freeze
()Make this config, and all subconfigs, read-only.
getFormattedInputSchema
(**kwargs)Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.
getInputSchema
(**kwargs)Return the schema an
AnalysisAction
expects to be present in the arguments supplied to the __call__ method.Returns a list of names that will be used as keys if this action's call method returns a mapping.
Return the schema an
AnalysisAction
will produce, if the__call__
method returnsKeyedData
, otherwise this may return None.items
()Get configurations as
(field name, field value)
pairs.keys
()Get field names.
load
(filename[, root])Modify this config in place by executing the Python code in a configuration file.
loadFromStream
(stream[, root, filename])Modify this Config in place by executing the Python code in the provided stream.
loadFromString
(code[, root, filename])Modify this Config in place by executing the Python code in the provided string.
makePlot
(data[, plotInfo, sumStats])Make a skyPlot of the given data.
names
()Get all the field names in the config, recursively.
save
(filename[, root])Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream
(outfile[, root, skipImports])Save a configuration file to a stream, which, when loaded, reproduces this config.
saveToString
([skipImports])Return the Python script form of this configuration as an executable string.
Subclass hook for computing defaults.
statsAndText
(arr[, mask])Calculate some stats from an array and return them and some text.
toDict
()Make a dictionary of field names and their values.
update
(**kw)Update values of fields specified by the keyword arguments.
validate
()Validate the Config, raising an exception if invalid.
values
()Get field values.
Attributes Documentation
- applyContext¶
Apply a
Context
to anAnalysisAction
recursively.Generally this method is called from within an
AnalysisTool
to configure allAnalysisAction
s at one time to make sure that they all are consistently configured. However, it is permitted to call this method if you are aware of the effects, or from within a specific execution environment like a python shell or notebook.- Parameters:
- context
Context
The specific execution context, this may be a single context or a joint context, see
Context
for more info.
- context
- history¶
Read-only history.
- identity: str | None = None¶
If a configurable action is assigned to a
ConfigurableActionField
, or aConfigurableActionStructField
the name of the field will be bound to this variable when it is retrieved.
- plotTypes¶
Selection of types of objects to plot. Can take any combination of stars, galaxies, unknown, mag, any. (
List
)
Methods Documentation
- __call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap], **kwargs) Mapping[str, Figure] | Figure ¶
Call self as a function.
- addInputSchema(inputSchema: HealSparseMap]]]) None ¶
Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to
getInputSchema
.- Parameters:
- inputSchema
KeyedDataSchema
A schema that is to be merged in with any existing schema when a call to
getInputSchema
is made.
- inputSchema
- compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)¶
Compare this configuration to another
Config
for equality.- Parameters:
- other
lsst.pex.config.Config
Other
Config
object to compare against this config.- shortcut
bool
, optional If
True
, return as soon as an inequality is found. Default isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities.
- other
- Returns:
- isEqual
bool
True
when the twolsst.pex.config.Config
instances are equal.False
if there is an inequality.
- isEqual
See also
Notes
Unselected targets of
RegistryField
fields and unselected choices ofConfigChoiceField
fields are not considered by this method.Floating point comparisons are performed by
numpy.allclose
.
- formatHistory(name, **kwargs)¶
Format a configuration field’s history to a human-readable format.
- Parameters:
- name
str
Name of a
Field
in this config.- kwargs
Keyword arguments passed to
lsst.pex.config.history.format
.
- name
- Returns:
- history
str
A string containing the formatted history.
- history
See also
- freeze()¶
Make this config, and all subconfigs, read-only.
- getFormattedInputSchema(**kwargs) HealSparseMap]]] ¶
Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.
- Returns:
- result
KeyedDataSchema
The schema this action requires to be present when calling this action, formatted with any input arguments (e.g. band=’i’)
- result
- getInputSchema(**kwargs) HealSparseMap]]] ¶
Return the schema an
AnalysisAction
expects to be present in the arguments supplied to the __call__ method.- Returns:
- result
KeyedDataSchema
The schema this action requires to be present when calling this action, keys are unformatted.
- result
- getOutputNames() Iterable[str] ¶
Returns a list of names that will be used as keys if this action’s call method returns a mapping. Otherwise return an empty Iterable
- Returns:
- result
Iterable
ofstr
If a
PlotAction
produces more than one plot, this should be the keys the action will use in the returnedMapping
.
- result
- getOutputSchema() HealSparseMap]]] | None ¶
Return the schema an
AnalysisAction
will produce, if the__call__
method returnsKeyedData
, otherwise this may return None.- Returns:
- result
KeyedDataSchema
or None The schema this action will produce when returning from call. This will be unformatted if any templates are present. Should return None if action does not return
KeyedData
.
- result
- items()¶
Get configurations as
(field name, field value)
pairs.- Returns:
- items
dict_items
Iterator of tuples for each configuration. Tuple items are:
Field name.
Field value.
- items
- keys()¶
Get field names.
- Returns:
- names
dict_keys
List of
lsst.pex.config.Field
names.
- names
See also
lsst.pex.config.Config.iterkeys
- load(filename, root='config')¶
Modify this config in place by executing the Python code in a configuration file.
- Parameters:
- filename
str
Name of the configuration file. A configuration file is Python module.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.
- filename
- loadFromStream(stream, root='config', filename=None)¶
Modify this Config in place by executing the Python code in the provided stream.
- Parameters:
- streamfile-like object,
str
,bytes
, or compiled string Stream containing configuration override code. If this is a code object, it should be compiled with
mode="exec"
.- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.
- streamfile-like object,
See also
Notes
For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use
loadFromString
instead for most of these types.
- loadFromString(code, root='config', filename=None)¶
Modify this Config in place by executing the Python code in the provided string.
- Parameters:
- code
str
,bytes
, or compiled string Stream containing configuration override code.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.
- code
- makePlot(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap], plotInfo: Mapping[str, str] | None = None, sumStats: Mapping | None = None, **kwargs) Figure ¶
Make a skyPlot of the given data.
- Parameters:
- Returns:
pipeBase.Struct
containing:- skyPlot
matplotlib.figure.Figure
The resulting figure.
- skyPlot
Notes
Expects the data to contain slightly different things depending on the types specified in plotTypes. This is handled automatically if you go through the pipetask framework but if you call this method separately then you need to make sure that data contains what the code is expecting.
If stars is in the plot types given then it is expected that data contains: xStars, yStars, zStars and starStatMask.
If galaxies is present: xGalaxies, yGalaxies, zGalaxies and galaxyStatsMask.
If unknown is present: xUnknowns, yUnknowns, zUnknowns and unknownStatMask.
If any is specified: x, y, z, statMask.
These options are not exclusive and multiple can be specified and thus need to be present in data.
Examples
An example of the plot produced from this code is here:
For a detailed example of how to make a plot from the command line please see the getting started guide.
- save(filename, root='config')¶
Save a Python script to the named file, which, when loaded, reproduces this config.
- Parameters:
- filename
str
Desination filename of this configuration.
- root
str
, optional Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).
- filename
- saveToStream(outfile, root='config', skipImports=False)¶
Save a configuration file to a stream, which, when loaded, reproduces this config.
- Parameters:
- outfilefile-like object
Destination file object write the config into. Accepts strings not bytes.
- root
Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).- skipImports
bool
, optional If
True
then do not includeimport
statements in output, this is to support human-oriented output frompipetask
where additional clutter is not useful.
- saveToString(skipImports=False)¶
Return the Python script form of this configuration as an executable string.
- Parameters:
- Returns:
- code
str
A code string readable by
loadFromString
.
- code
- setDefaults()¶
Subclass hook for computing defaults.
Notes
Derived
Config
classes that must compute defaults rather than using theField
instances’s defaults should do so here. To correctly use inherited defaults, implementations ofsetDefaults
must call their base class’ssetDefaults
.
- statsAndText(arr, mask=None)¶
Calculate some stats from an array and return them and some text.
- toDict()¶
Make a dictionary of field names and their values.
See also
Notes
This method uses the
toDict
method of individual fields. Subclasses ofField
may need to implement atoDict
method for this method to work.
- update(**kw)¶
Update values of fields specified by the keyword arguments.
- Parameters:
- kw
Keywords are configuration field names. Values are configuration field values.
Notes
The
__at
and__label
keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert aConfig
instance’s history.Examples
This is a config with three fields:
>>> from lsst.pex.config import Config, Field >>> class DemoConfig(Config): ... fieldA = Field(doc='Field A', dtype=int, default=42) ... fieldB = Field(doc='Field B', dtype=bool, default=True) ... fieldC = Field(doc='Field C', dtype=str, default='Hello world') ... >>> config = DemoConfig()
These are the default values of each field:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 42 fieldB: True fieldC: 'Hello world'
Using this method to update
fieldA
andfieldC
:>>> config.update(fieldA=13, fieldC='Updated!')
Now the values of each field are:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 13 fieldB: True fieldC: 'Updated!'
- validate()¶
Validate the Config, raising an exception if invalid.
- Raises:
- lsst.pex.config.FieldValidationError
Raised if verification fails.
Notes
The base class implementation performs type checks on all fields by calling their
validate
methods.Complex single-field validation can be defined by deriving new Field types. For convenience, some derived
lsst.pex.config.Field
-types (ConfigField
andConfigChoiceField
) are defined inlsst.pex.config
that handle recursing into subconfigs.Inter-field relationships should only be checked in derived
Config
classes after calling this method, and base validation is complete.
- values()¶
Get field values.
- Returns:
- values
dict_values
Iterator of field values.
- values