Skip to content

Latest commit

 

History

History
119 lines (83 loc) · 4.24 KB

enhanced-map.rst

File metadata and controls

119 lines (83 loc) · 4.24 KB
Raw

Enhanced Map (marvin.tools.quantities.EnhancedMap)

Introduction

An ~marvin.tools.quantities.EnhancedMap is a ~marvin.tools.quantities.Map that has been modified by a map arithmetic operation (+, -, *, /, or **). It inherits most of the attributes of a ~marvin.tools.quantities.Map. Notably, it lacks property and channel attributes in favor of history and parent attributes that describe its creation operation(s) and parent ~marvin.tools.quantities.Map object(s).

Getting Started

We can create an ~marvin.tools.quantities.EnhancedMap object by applying a map arithmetic operation to ~marvin.tools.quantities.Map object(s).

from marvin.tools.maps import Maps
maps = Maps(plateifu='8485-1901')
ha = maps['emline_gflux_ha_6564']
nii = maps['emline_gflux_nii_6585']

# All are EnhancedMap's.
sum_ = nii + ha
diff = nii - ha
prod = nii * ha
quot = nii / ha
pow_ = ha**0.5

Using ~marvin.tools.quantities.EnhancedMap ------------------------------------------

For more in-depth discussion of ~marvin.tools.quantities.Map methods and attributes, please see marvin-map.

Map Arithmetic

New in 2.2.0 ~marvin.tools.quantities.Map objects can be added, subtracted, multiplied, divided, or raised to a power.

ha = maps['emline_gflux_ha_6564']
nii = maps['emline_gflux_nii_6585']

sum_ = nii + ha
diff = nii - ha
prod = nii * ha
quot = nii / ha
pow_ = ha**0.5

prod
# <Marvin EnhancedMap '(emline_gflux_nii_6585 * emline_gflux_ha_6564)'>
# array([[ 0.,  0.,  0., ...,  0.,  0.,  0.],
#        [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#        [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#        ...,
#        [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#        [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#        [ 0.,  0.,  0., ...,  0.,  0.,  0.]]) 'erg2 / (cm4 s2 spaxel2)'

In addition to performing the arithmetic operation on the value, the resulting ~marvin.tools.quantities.EnhancedMap has correctly propagated ivar, mask, unit, and scale. Instead of property and channel attributes, ~marvin.tools.quantities.EnhancedMap objects have history and parent attributes about their creation operation(s) and parent ~marvin.tools.quantities.Map object(s).

prod.history  # '(emline_gflux_nii_6585 * emline_gflux_ha_6564)'

prod.parents
# [<Marvin Map (plateifu='8485-1901', property='emline_gflux', channel=<Channel 'nii_6585' unit='km / s'>)>
#  array([[ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         ...,
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.]]) erg / (cm2 s spaxel),
#  <Marvin Map (plateifu='8485-1901', property='emline_gflux', channel=<Channel 'ha_6564' unit='km / s'>)>
#  array([[ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         ...,
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.],
#         [ 0.,  0.,  0., ...,  0.,  0.,  0.]]) erg / (cm2 s spaxel)]

Reference/API

Class Inheritance Diagram

marvin.tools.quantities.EnhancedMap

Class

marvin.tools.quantities.EnhancedMap

Methods

marvin.tools.quantities.EnhancedMap.save marvin.tools.quantities.EnhancedMap.restore marvin.tools.quantities.EnhancedMap.masked marvin.tools.quantities.EnhancedMap.error marvin.tools.quantities.EnhancedMap.snr marvin.tools.quantities.EnhancedMap.plot