Skip to content

Fetch Maps

chips.fetch.SolarDisk

Bases: object

An object subclass that holds all the information on solar disk.

Attributes:

Name Type Description
date datetime.datetime

Datetime of the solar disk '.fits' file.

wavelength int

Wave length of the disk image [171/193/211].

resolution int

Resolution of the image to work on [4096].

apply_psf bool

If true, conduct deconvololution with a point spread function.

norm bool

If true, conduct image registrtation and normalization.

use_gpu bool

If true and cupy is installed, do PSF deconvolution on the GPU with cupy.

local_file str

Regular expression that captures the local system file.

desciption str

Holds description of the '.fits' file.

raw sunpy.map.Map

Holds raw solar disk Map.

psf sunpy.map.Map

Holds deconvolved solar disk Map.

normalized sunpy.map.Map

Holds normalized solar disk Map (using raw or psf).

pixel_radius int

Holds solar disk radii in pixel.

fetch()

Methods to fetch AIA disk '.fits' files from remote 'JSOC' or local storage.

Returns:

Type Description
None

Method returns None

set_value(key, value)

Methods to set an attribute inside chips.fetch.SolarDisk object.

Parameters:

Name Type Description Default
key str

Key/name of the attribute

required
value Any

Value to set as attribute

required

Returns:

Type Description
None

Method returns None

get_value(key)

Methods to get an attribute from chips.fetch.SolarDisk object.

Parameters:

Name Type Description Default
key str

Key/name of the attribute

required

Returns:

Type Description
Any

Method returns a object if available

normalization()

Methods to search AIA files in local system

Returns:

Type Description
None

Method returns a file name if file avilable

search_local()

Methods to search AIA disk '.fits' files in local system

Returns:

Type Description
str

Method returns a file name if file avilable.

fetch_solar_parameters()

Methods to fetch solar disk parameters. Sets solar radii in pixel.

Returns:

Type Description
None

Method returns None

plot_disk_images(types=['raw', 'normalized'], figsize=(6, 3), dpi=240, nrows=1, ncols=2, fname=None)

Plotting method to generate diagonestics plots

Parameters:

Name Type Description Default
types List[str]

Name of the map attributes to plot ['raw','normalized','psf'].

['raw', 'normalized']
figsize Tuple[int]

Size of the figure.

(6, 3)
dpi int

Figure DPI.

240
nrows int

Number of rows in the figure.

1
ncols int

Number of columns in the figure.

2
fname str

File name of the figure (expected file format: png, bmp, pdf, jpg).

None

Returns:

Type Description
None

Method returns None

chips.fetch.RegisterAIA

Bases: object

An object superclass that holds all the information on chips.fetch.SolarDisk.

Attributes:

Name Type Description
date datetime.datetime

Datetime of the solar disk '.fits' file.

wavelengths List[int]

List of wavelength of the disk image [171/193/211] to be run.

resolution int

Resolutions of the image to work on 4096 (4k).

apply_psf bool

If true, conduct deconvololution with a point spread function.

norm bool

If true, conduct image registrtation and normalization.

local_file str

Regular expression that captures the local system file.

save_dir str

Save directory local for dataset (filtered and analyzed).

plot_scatter_maps(figsize=(6, 9), dpi=240, nrows=3, ncols=2, fname=None, scale='linear')

Plotting method to generate scatter

Parameters:

Name Type Description Default
figsize Tuple[int]

Size of the figure.

(6, 9)
dpi int

Figure DPI.

240
nrows int

Number of rows in the figure.

3
ncols int

Number of columns in the figure.

2
fname str

File name of the figure (expected file format: png, bmp, pdf, jpg).

None

Returns:

Type Description
None

Method returns None

chips.fetch.SynopticMap

Bases: object

An object class that holds all the information on solar synoptic maps.

Attributes:

Name Type Description
date datetime.datetime

Datetime of the solar disk '.fits' file.

CR_equivalance int

Carrington rotation number (if not provided then computed by date)

wavelength int

Wave length of the disk image [171/193/211].

desciption str

Holds description of the '.fits' file.

location str

Local file store to save the synoptic maps.

base_url_regex str

Regex of the JSOC/SDO repository url.

file_name_regex str

Regex of the local file name.

raw sunpy.map.Map

Holds raw solar disk Map.

fetch()

Method to download and store the remote files to local folder and fetch it into sunpy.map.Map object.

Returns:

Type Description
None

Method returns None

set_value(key, value)

Methods to set an attribute inside chips.fetch.SynopticMap object.

Parameters:

Name Type Description Default
key str

Key/name of the attribute

required
value Any

Value to set as attribute

required

Returns:

Type Description
None

Method returns None

get_value(key)

Methods to get an attribute from chips.fetch.SynopticMap object.

Parameters:

Name Type Description Default
key str

Key/name of the attribute

required

Returns:

Type Description
Any

Method returns a object if available