hawc_hal.region_of_interest.healpix_map_roi.HealpixMapROI.display() - Code Metrics - Inspection of "Arbitrary ROIs defined as Healpix maps" - giacomov/hawc_hal - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#11)

unknown

created 2018-09-18 17:38 UTC

HealpixMapROI.display() A

↳ Parent: hawc_hal.region_of_interest.healpix_map_roi

Complexity

Conditions

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nop	1

import numpy as np
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
import astropy.units as u
import healpy as hp
from astropy.io import fits


from threeML.exceptions.custom_exceptions import custom_warnings
from astromodels.core.sky_direction import SkyDirection

from healpix_roi_base import HealpixROIBase, _RING, _NESTED

from healpix_cone_roi import HealpixConeROI, _get_radians

from ..healpix_handling import radec_to_vec

from ..flat_sky_projection import FlatSkyProjection


class HealpixMapROI(HealpixROIBase):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def __init__(self, model_radius, map=None, file = None, threshold=0.5, *args, **kwargs):

        """
        A cone Region of Interest defined by a healpix map (can be read from a fits file).
        User needs to supply a cone region (center and radius) defining the plane projection for the model map.

        Examples:

            Model map centered on (R.A., Dec) = (1.23, 4.56) in J2000 ICRS coordinate system, with a radius of 5 degrees, ROI defined in healpix map in fitsfile:


            > roi = HealpixMapROI(5.0, ra=1.23, dec=4.56, file = "myROI.fits" )

            Model map centered on (L, B) = (1.23, 4.56) (Galactic coordiantes) with a radius of 30 arcmin, ROI defined on-the-fly in healpix map:


            > roi = HealpixMapROI(30.0 * u.arcmin, l=1.23, dec=4.56, map = my_roi)

        :param model_radius: radius of the model cone. Either an astropy.Quantity instance, or a float, in which case it
        is assumed to be the radius in degrees
        :param map: healpix map containing the ROI.
        :param file: fits file containing a healpix map with the ROI.
        :param threshold: value below which pixels in the map will be set inactive (=not in ROI).
        :param args: arguments for the SkyDirection class of astromodels
        :param kwargs: keywords for the SkyDirection class of astromodels
        """
 

        assert file is not None or map is  not None, "Must supply either healpix map or fits file to create HealpixMapROI"


        self._center = SkyDirection(*args, **kwargs)

        self._model_radius_radians = _get_radians(model_radius)
         

        self._threshold  = threshold

 

        self.read_map( map=map, file=file )



    def read_map( self, map=None, file=None ):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        assert file is not None or map is  not None, "Must supply either healpix map or fits file"
 

        if map is not None:
            map = map
            self._filename = None

        elif file is not None:
            self._filename = file
            map =  hp.fitsfunc.read_map(self._filename)


        self._maps = {}

        self._original_nside = hp.npix2nside( map.shape[0] )

        self._maps[self._original_nside] = map
        

        self.check_roi_inside_model()


    def check_roi_inside_model( self ):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
      

        active_pixels = self.active_pixels( self._original_nside )

        

        radius = np.rad2deg(self._model_radius_radians)
        ra, dec = self.ra_dec_center

        temp_roi =  HealpixConeROI( data_radius = radius , model_radius=radius, ra=ra, dec=dec )

        

        model_pixels = temp_roi.active_pixels( self._original_nside )

        

        if not all(p in model_pixels for p in active_pixels):
            custom_warnings.warn("Some pixels inside your ROI are not contained in the model map.")

    def to_dict(self):

        ra, dec = self.ra_dec_center


        s = {'ROI type': type(self).__name__.split(".")[-1],

             'ra': ra,
             'dec': dec,
             'model_radius_deg': np.rad2deg(self._model_radius_radians),
             'map': self._maps[self._original_nside],
             'threshold': self._threshold,
             'file': self._filename }


        return s

    @classmethod
    def from_dict(cls, data):

        return cls(data['model_radius_deg'], threshold = data['threshold'], map = data['map'], ra=data['ra'], dec=data['dec'], file=data['file'])


    def __str__(self):

        s = ("%s: Center (R.A., Dec) = (%.3f, %.3f), model radius: %.3f deg, threshold = %.2f" %

              (type(self).__name__, self.ra_dec_center[0], self.ra_dec_center[1],

               self.model_radius.to(u.deg).value, self._threshold))


        if self._filename is not None: 

            s  =  "%s,  data ROI from %s" %  (s, self._filename)

            

        return s

    def display(self):

        print(self)


    @property
    def ra_dec_center(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        return self._get_ra_dec()

    @property
    def model_radius(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return self._model_radius_radians * u.rad

    @property
    def threshold(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return self._threshold

    def _get_ra_dec(self):

        lon, lat = self._center.get_ra(), self._center.get_dec()

        return lon, lat

    def _active_pixels(self, nside, ordering):

        nest = ordering is _NESTED

            

        if not nside in self._maps:
          self._maps[nside] = hp.ud_grade(self._maps[self._original_nside], nside_out=nside)


        pixels_inside_map = np.where( self._maps[ nside ] >= self._threshold )[0]


        return pixels_inside_map

    def get_flat_sky_projection(self, pixel_size_deg):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        # Decide side for image

        # Compute number of pixels, making sure it is going to be even (by approximating up)
        npix_per_side = 2 * int(np.ceil(np.rad2deg(self._model_radius_radians) / pixel_size_deg))

        # Get lon, lat of center
        ra, dec = self._get_ra_dec()


        # This gets a list of all RA, Decs for an AIT-projected image of npix_per_size x npix_per_side
        flat_sky_proj = FlatSkyProjection(ra, dec, pixel_size_deg, npix_per_side, npix_per_side)

        return flat_sky_proj




1			import numpy as np
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2			import astropy.units as u
3			import healpy as hp
4			from astropy.io import fits
			0 ignored issues – show Unused Code introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Unused fits imported from astropy.io Loading history... introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Imports from package astropy are not grouped Loading history...
5
6			from threeML.exceptions.custom_exceptions import custom_warnings
7			from astromodels.core.sky_direction import SkyDirection
8
9			from healpix_roi_base import HealpixROIBase, _RING, _NESTED
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Relative import 'healpix_roi_base', should be 'hawc_hal.region_of_interest.healpix_roi_base' Loading history... Unused Code introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Unused _RING imported from healpix_roi_base Loading history...
10			from healpix_cone_roi import HealpixConeROI, _get_radians
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Relative import 'healpix_cone_roi', should be 'hawc_hal.region_of_interest.healpix_cone_roi' Loading history...
11			from ..healpix_handling import radec_to_vec
			0 ignored issues – show Unused Code introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Unused radec_to_vec imported from healpix_handling Loading history...
12			from ..flat_sky_projection import FlatSkyProjection
13
14
15			class HealpixMapROI(HealpixROIBase):
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
16
17			def __init__(self, model_radius, map=None, file = None, threshold=0.5, args, *kwargs):
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report No space allowed around keyword argument assignment Loading history... Bug Best Practice introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `map`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history... Bug Best Practice introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `file`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history... introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report Keyword argument before variable positional arguments list in the definition of __init__ function Loading history...
18			"""
19			A cone Region of Interest defined by a healpix map (can be read from a fits file).
20			User needs to supply a cone region (center and radius) defining the plane projection for the model map.
21
22			Examples:
23
24			Model map centered on (R.A., Dec) = (1.23, 4.56) in J2000 ICRS coordinate system, with a radius of 5 degrees, ROI defined in healpix map in fitsfile:
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (161/120). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
25
26			> roi = HealpixMapROI(5.0, ra=1.23, dec=4.56, file = "myROI.fits" )
27
28			Model map centered on (L, B) = (1.23, 4.56) (Galactic coordiantes) with a radius of 30 arcmin, ROI defined on-the-fly in healpix map:
			0 ignored issues – show Coding Style introduced 2018-09-18 17:51 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (145/120). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
29
30			> roi = HealpixMapROI(30.0 * u.arcmin, l=1.23, dec=4.56, map = my_roi)
31

giacomov / hawc_hal

Pull Request — master (#11)

HealpixMapROI.display() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like