create_mask#

create_mask(mask_type, sigma_decay=0, **kwargs)[source]#

Creates a mask of the specified type.

Parameters:

mask_typestr

Type of the mask to be created. Can be one of:

box

Box mask (see box_mask())

tube

Cylindrical mask (see tube_mask())

ellipse

Ellipsoidal mask (see elliptical_mask())

sigma_decayfloat, optional

Smoothing along mask edges using a Gaussian filter, 0 by default.

kwargsdict

Parameters passed to the indivdual mask creation funcitons.

Returns:

Raises:

box	Box mask (see `box_mask()`)
tube	Cylindrical mask (see `tube_mask()`)
ellipse	Ellipsoidal mask (see `elliptical_mask()`)