hawc_hal.region_of_interest.healpix_cone_roi

Complexity

Total Complexity

14

Size/Duplication

Total Lines	135
Duplicated Lines	10.37 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	HealpixConeROI.ra_dec_center()	0	4	1
A	HealpixConeROI.model_radius()	0	3	1
A	HealpixConeROI.display()	0	3	1
A	HealpixConeROI.data_radius()	0	4	1
A	HealpixConeROI.from_dict()	0	4	1
A	HealpixConeROI._active_pixels()	0	9	1
A	HealpixConeROI._get_healpix_vec()	0	7	1
A	HealpixConeROI._get_ra_dec()	0	5	1
A	HealpixConeROI.to_dict()	0	11	1
A	HealpixConeROI.__init__()	0	26	1
A	HealpixConeROI.__str__()	0	7	1
A	HealpixConeROI.get_flat_sky_projection()	14	14	1

import numpy as np

This module should have a docstring.

import astropy.units as u
import healpy as hp
from healpix_roi_base import HealpixROIBase, _RING, _NESTED

Relative import 'healpix_roi_base', should be 'hawc_hal.region_of_interest.healpix_roi_base'

Unused _RING imported from healpix_roi_base

from astromodels.core.sky_direction import SkyDirection

third party import "from astromodels.core.sky_direction import SkyDirection" should be placed before "from healpix_roi_base import HealpixROIBase, _RING, _NESTED"

from ..healpix_handling import radec_to_vec
from ..flat_sky_projection import FlatSkyProjection


def _get_radians(my_angle):

    if isinstance(my_angle, u.Quantity):

        my_angle_radians = my_angle.to(u.rad).value

    else:

        my_angle_radians = np.deg2rad(my_angle)

    return my_angle_radians


class HealpixConeROI(HealpixROIBase):

This class should have a docstring.

    def __init__(self, data_radius, model_radius, *args, **kwargs):
        """
        A cone Region of Interest defined by a center and a radius.

        Examples:

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

            > roi = HealpixConeROI(5.0, ra=1.23, dec=4.56)

            ROI centered on (L, B) = (1.23, 4.56) (Galactic coordiantes) with a radius of 30 arcmin:

            > roi = HealpixConeROI(30.0 * u.arcmin, l=1.23, dec=4.56)

        :param data_radius: radius of the cone. Either an astropy.Quantity instance, or a float, in which case it is assumed

This line is too long as per the coding-style (124/120).

        to be the radius in degrees
        :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 args: arguments for the SkyDirection class of astromodels
        :param kwargs: keywords for the SkyDirection class of astromodels
        """

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

        self._data_radius_radians = _get_radians(data_radius)
        self._model_radius_radians = _get_radians(model_radius)

    def to_dict(self):

        ra, dec = self.ra_dec_center

Variable name "ra" doesn't conform to snake_case naming style ('(([a-z_][a-z0-9_]2,30)|(_[a-z0-9_]*)|(__[a-z][a-z0-9_]+__))$' pattern)

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

Variable name "s" doesn't conform to snake_case naming style ('(([a-z_][a-z0-9_]2,30)|(_[a-z0-9_]*)|(__[a-z][a-z0-9_]+__))$' pattern)

             'ra': ra,
             'dec': dec,
             'data_radius_deg': np.rad2deg(self._data_radius_radians),
             'model_radius_deg': np.rad2deg(self._model_radius_radians)}

        return s

    @classmethod
    def from_dict(cls, data):

        return cls(data['data_radius_deg'], data['model_radius_deg'], ra=data['ra'], dec=data['dec'])

    def __str__(self):

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

Variable name "s" doesn't conform to snake_case naming style ('(([a-z_][a-z0-9_]2,30)|(_[a-z0-9_]*)|(__[a-z][a-z0-9_]+__))$' pattern)

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

Wrong continued indentation (remove 1 space).

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

Module 'astropy.units' has no 'deg' member; maybe 'dex'?

        return s

    def display(self):

        print(self)

There is an unnecessary parenthesis after print.

    @property
    def ra_dec_center(self):

This method should have a docstring.

        return self._get_ra_dec()

    @property
    def data_radius(self):

This method should have a docstring.

        return self._data_radius_radians * u.rad

    @property
    def model_radius(self):

This method should have a docstring.

        return self._model_radius_radians * u.rad

    def _get_ra_dec(self):

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

        return lon, lat

    def _get_healpix_vec(self):

        lon, lat = self._get_ra_dec()

        vec = radec_to_vec(lon, lat)

        return vec

    def _active_pixels(self, nside, ordering):

        vec = self._get_healpix_vec()

        nest = ordering is _NESTED

        pixels_inside_cone = hp.query_disc(nside, vec, self._data_radius_radians, inclusive=False, nest=nest)

        return pixels_inside_cone

    def get_flat_sky_projection(self, pixel_size_deg):

This method should have a docstring.

This code seems to be duplicated in your project.

        # 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()

Variable name "ra" doesn't conform to snake_case naming style ('(([a-z_][a-z0-9_]2,30)|(_[a-z0-9_]*)|(__[a-z][a-z0-9_]+__))$' pattern)

        # 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

Trailing newlines