ximage.accessor package

Submodules

ximage.accessor.methods module

ximage xarray-accessor methods.

class ximage.accessor.methods.XImage_Base_Accessor(xarray_obj)

Bases: object

XImage Base Accessor for xarray objects.

Create a new XImage_Base_Accessor object.

label(*, variable=None, core_dims=None, min_value_threshold=0.1, max_value_threshold=inf, min_area_threshold=1, max_area_threshold=inf, footprint=None, sort_by='area', sort_decreasing=True, labeled_comprehension_kwargs=None, label_name='label')

Label the xarray object.

label_patches(*, patch_size, variable=None, label_name='label', n_patches=None, n_labels=None, labels_id=None, highlight_label_id=True, centered_on='max', padding=0, n_patches_per_label=None, n_patches_per_partition=1, partitioning_method=None, n_partitions_per_label=None, kernel_size=None, buffer=0, stride=None, include_last=True, ensure_slice_size=True, debug=False, verbose=False)

Extract patches around labels of the xarray DataArray label_name.

label_patches_isel_dicts(*, label_name, patch_size, variable=None, n_patches=None, n_labels=None, labels_id=None, centered_on='max', padding=0, n_patches_per_label=None, n_patches_per_partition=1, partitioning_method=None, n_partitions_per_label=None, kernel_size=None, buffer=0, stride=None, include_last=True, ensure_slice_size=True, debug=False, verbose=False)

Return isel-dictionaries to extract patches around labels.

class ximage.accessor.methods.XImage_DataArray_Accessor(xarray_obj)

Bases: XImage_Base_Accessor

XImage DataArray Accessor for xarray objects.

Initialize a XImage_DataArray_Accessor object.

plot_labels(*, x=None, y=None, ax=None, max_n_labels=50, add_colorbar=True, cmap='Paired', use_imshow=False, **plot_kwargs)

Plot the labels on the xarray object.

class ximage.accessor.methods.XImage_Dataset_Accessor(xarray_obj)

Bases: XImage_Base_Accessor

XImage Dataset Accessor for xarray objects.

Initialize a XImage_Dataset_Accessor object.

Module contents

ximage xarray-accessor methods.

class ximage.accessor.XImage_DataArray_Accessor(xarray_obj)

Bases: XImage_Base_Accessor

XImage DataArray Accessor for xarray objects.

Initialize a XImage_DataArray_Accessor object.

plot_labels(*, x=None, y=None, ax=None, max_n_labels=50, add_colorbar=True, cmap='Paired', use_imshow=False, **plot_kwargs)

Plot the labels on the xarray object.

class ximage.accessor.XImage_Dataset_Accessor(xarray_obj)

Bases: XImage_Base_Accessor

XImage Dataset Accessor for xarray objects.

Initialize a XImage_Dataset_Accessor object.