CHIPS Tools (Synoptic Map)

`chips.syn_chips.SynopticChips`

Bases: object

An object class that runs the CHIPS algorithm on synoptic maps step-by-step with a set of input parameters.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Map object that holds all the information on `chips.fetch.SynopticMap`.
`base_folder`	`str`	Base folder to store the processed figures and datasets.
`medfilt_kernel`	`int`	Median filtering Gaussian kernel size (odd number).
`h_bins`	`int`	Number of bins in histogram while running Otsu's method.
`h_thresh`	`float`	Otsu's thresold (computed inside if not given, \(I_{th}\)).
`ht_peak_ratio`	`int`	Needed to cpmpute threhold while computing Otsu's method.
`hist_xsplit`	`int`	Needed to compute thresholds by splitted image (number of splitted along the image width).
`hist_ysplit`	`int`	Needed to compute thresholds by splitted image (number of splitted along the image height).
`threshold_range`	`List[float]`	List of thresholds from `h_thresh` to run CHIPS.
`porb_threshold`	`int`	This is \(x_{\tau}\).

`get_base_folder()`

Method to find local base folder to store figures and outputs.

Returns:

Type	Description
`None`	Method returns None.

`run_CHIPS()`

This method selects the chips.fetch.SynopticMap objects and runs the CHIPS algorithm sequentially.

Returns:

Type	Description
`None`	Method returns None.

`run_filters(synoptic_map)`

This method runs the Gaussian filter on solar Synoptic Maps, using method described in this Section.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar synoptic Maps to run CHIPS algorithm.

Returns:

Type	Description
`None`	Method returns None.

`extract_histogram(synoptic_map)`

This method extract Otsu's threshold, using method described in this Section.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar synoptic Maps to run CHIPS algorithm.

Returns:

Type	Description
`None`	Method returns None.

`extract_histograms(synoptic_map)`

Method extracting Otsu's thresolds by splitting solar Synoptic Map into different windows (windows are estimated using xsplit, ysplit).

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar synoptic Maps to run CHIPS algorithm.

Returns:

Type	Description
`None`	Method returns None.

`extract_sliding_histograms(synoptic_map)`

Method extracting Otsu's thresolds by sliding a window (size determined by xsplit, ysplit) through the solar Synoptic Map.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar synoptic Maps to run CHIPS algorithm.

Returns:

Type	Description
`None`	Method returns None.

`extract_CHs_CHBs(synoptic_map)`

Method extracting coronal hole and boundaries using method described in this Section.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar synoptic Maps to run CHIPS algorithm.

Returns:

Type	Description
`None`	Method returns None.

`calculate_prob(data, thresholds)`

Method to estimate probability for each CH region identified by CHIPS.

Attributes:

Name	Type	Description
`data`	`np.array`	Numpy 1D array holding '.fits' level intensity (I) dataset.
`thresholds`	`float`	Intensity thresold (\(I_{th}\)).

Returns:

Name	Type	Description
`p`	`float`	Probability [\(\theta\)] of each region estimated using Beta function.

`plot_diagonestics(synoptic_map, dpi=240, prob_lower_lim=0.0)`

Method to create diagonestics plots showing different steps of CHIPS. Expected file formats png, bmp, jpg, pdf, etc.

Attributes:

Name	Type	Description
`synoptic_map`	`chips.fetch.SynopticMap`	Solar Synoptic Map object that holds all information for drawing.
`dpi`	`int`	Dots per linear inch.
`prob_lower_lim`	`float`	Minimum limit of the color bar.

Returns:

Type	Description
`None`	Method returns None.