diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..4beb293 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 78f9fdb9e56f5b1684ecc386a5dca1eb +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/documentation/medipt.crop_image.doctree b/.doctrees/documentation/medipt.crop_image.doctree new file mode 100644 index 0000000..5650284 Binary files /dev/null and b/.doctrees/documentation/medipt.crop_image.doctree differ diff --git a/.doctrees/documentation/medipt.doctree b/.doctrees/documentation/medipt.doctree new file mode 100644 index 0000000..473762c Binary files /dev/null and b/.doctrees/documentation/medipt.doctree differ diff --git a/.doctrees/documentation/medipt.resample_image.doctree b/.doctrees/documentation/medipt.resample_image.doctree new file mode 100644 index 0000000..69a95d4 Binary files /dev/null and b/.doctrees/documentation/medipt.resample_image.doctree differ diff --git a/.doctrees/documentation/medipt.transforms.doctree b/.doctrees/documentation/medipt.transforms.doctree new file mode 100644 index 0000000..2a949aa Binary files /dev/null and b/.doctrees/documentation/medipt.transforms.doctree differ diff --git a/.doctrees/documentation/medipt.transforms.intensity.doctree b/.doctrees/documentation/medipt.transforms.intensity.doctree new file mode 100644 index 0000000..bca2162 Binary files /dev/null and b/.doctrees/documentation/medipt.transforms.intensity.doctree differ diff --git a/.doctrees/documentation/medipt.transforms.spatial.doctree b/.doctrees/documentation/medipt.transforms.spatial.doctree new file mode 100644 index 0000000..e25375b Binary files /dev/null and b/.doctrees/documentation/medipt.transforms.spatial.doctree differ diff --git a/.doctrees/documentation/medipt.transforms.spatial.functional_legacy.doctree b/.doctrees/documentation/medipt.transforms.spatial.functional_legacy.doctree new file mode 100644 index 0000000..95a9113 Binary files /dev/null and b/.doctrees/documentation/medipt.transforms.spatial.functional_legacy.doctree differ diff --git a/.doctrees/documentation/medipt.utils.doctree b/.doctrees/documentation/medipt.utils.doctree new file mode 100644 index 0000000..0c4d244 Binary files /dev/null and b/.doctrees/documentation/medipt.utils.doctree differ diff --git a/.doctrees/documentation/modules.doctree b/.doctrees/documentation/modules.doctree new file mode 100644 index 0000000..3e51dcf Binary files /dev/null and b/.doctrees/documentation/modules.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 0000000..5b52ae0 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 0000000..ceda9e3 Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/install/installation.doctree b/.doctrees/install/installation.doctree new file mode 100644 index 0000000..ab86b06 Binary files /dev/null and b/.doctrees/install/installation.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..ea2df06 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +medipt.org diff --git a/_modules/index.html b/_modules/index.html new file mode 100644 index 0000000..e13ecae --- /dev/null +++ b/_modules/index.html @@ -0,0 +1,134 @@ + + + + + + Overview: module code — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/crop_image/threshold_crop_background.html b/_modules/medipt/crop_image/threshold_crop_background.html new file mode 100644 index 0000000..15894f8 --- /dev/null +++ b/_modules/medipt/crop_image/threshold_crop_background.html @@ -0,0 +1,134 @@ + + + + + + medipt.crop_image.threshold_crop_background — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.crop_image.threshold_crop_background

+import SimpleITK as sitk
+from typing import Union
+
+
[docs]def threshold_crop_background(image: sitk.Image, + inside_value: Union[int, float], + outside_value: Union[int, float], + *args, **kwargs) -> sitk.Image: + + + binary_image_filter = sitk.OtsuThresholdImageFilter() + binary_image_filter.SetInsideValue(inside_value) + binary_image_filter.SetOutsideValue(outside_value) + + binary_image = binary_image_filter.Execute(image) + + label_shape_filter = sitk.LabelShapeStatisticsImageFilter() + label_shape_filter.Execute(binary_image) + bounding_box = label_shape_filter.GetBoundingBox(outside_value) + # The bounding box's first "dim" entries are the starting index and last "dim" entries the size + + cropped_image = sitk.RegionOfInterest(image, bounding_box[int(len(bounding_box)/2):], bounding_box[0:int(len(bounding_box)/2)]) + + return cropped_image
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/resample_image/resample_image.html b/_modules/medipt/resample_image/resample_image.html new file mode 100644 index 0000000..120af1f --- /dev/null +++ b/_modules/medipt/resample_image/resample_image.html @@ -0,0 +1,338 @@ + + + + + + medipt.resample_image.resample_image — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.resample_image.resample_image

+import numpy as np
+import SimpleITK as sitk
+from typing import Union, Tuple, List, Callable, Iterable
+
+
+
[docs]def get_sitk_interpolator(interpolator): + """ + Return an sitk interpolator object for the given string. + + :param interpolator: Interpolator type as string. + 'nearest': sitk.sitkNearestNeighbor + 'linear': sitk.sitkLinear + 'cubic': sitk.sitkBSpline + 'label_gaussian': sitk.sitkLabelGaussian + 'gaussian': sitk.sitkGaussian + 'lanczos': sitk.sitkLanczosWindowedSinc + :return: The sitk interpolator object. + + """ + + if isinstance(interpolator, str): + + if interpolator == 'nearest': + return sitk.sitkNearestNeighbor + elif interpolator == 'linear': + return sitk.sitkLinear + elif interpolator == 'cubic': + return sitk.sitkBSpline + elif interpolator == 'label_gaussian': + return sitk.sitkLabelGaussian + elif interpolator == 'gaussian': + return sitk.sitkGaussian + elif interpolator == 'lanczos': + return sitk.sitkLanczosWindowedSinc + + elif isinstance(interpolator, int): + return interpolator + + else: + raise Exception('invalid interpolator type')
+ + + + +
[docs]def get_simpleitk_pix_type(pixel_type: Union[str, int]) -> int: + """ + Returns the SimpleITK pixel type for the given pixel type string. + + :param pixel_type: The pixel type as string. + 'float32': sitk.sitkFloat32 + 'float64': sitk.sitkFloat64 + 'int8': sitk.sitkInt8 + 'int16': sitk.sitkInt16 + 'int32': sitk.sitkInt32 + 'int64': sitk.sitkInt64 + 'uint8': sitk.sitkUInt8 + 'uint16': sitk.sitkUInt16 + 'uint32': sitk.sitkUInt32 + 'uint64': sitk.sitkUInt64 + 'complex64': sitk.sitkComplexFloat32 + 'complex128': sitk.sitkComplexFloat64 + :return: The SimpleITK pixel type. + """ + + if isinstance(pixel_type, str): + + if pixel_type == 'float32': + return sitk.sitkFloat32 + elif pixel_type == 'float64': + return sitk.sitkFloat64 + elif pixel_type == 'int8': + return sitk.sitkInt8 + elif pixel_type == 'int16': + return sitk.sitkInt16 + elif pixel_type == 'int32': + return sitk.sitkInt32 + elif pixel_type == 'int64': + return sitk.sitkInt64 + elif pixel_type == 'uint8': + return sitk.sitkUInt8 + elif pixel_type == 'uint16': + return sitk.sitkUInt16 + elif pixel_type == 'uint32': + return sitk.sitkUInt32 + elif pixel_type == 'uint64': + return sitk.sitkUInt64 + elif pixel_type == 'complex64': + return sitk.sitkComplexFloat32 + elif pixel_type == 'complex128': + return sitk.sitkComplexFloat64 + + elif isinstance(pixel_type, int): + return pixel_type + + else: + raise Exception('invalid pixel type')
+ + +
[docs]class ResampleImage: + def __init__(self, + + interpolator: Union[str, int] = 'linear', + + + post_processing_sitk: Union[Callable, Union[List[Callable]], Tuple[Callable, ...]] = None, + + pixel_type: [str, int] = 'float32', + default_pixel_value: Union[float, int, None] = None, + + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + + + + self.used_dimensions = used_dimensions or [True] * dim + self.dim = dim + + self.seed = seed + self.legacy_random_state = legacy_random_state + + + self.interpolator = interpolator + self.post_processing_sitk = post_processing_sitk + self.pixel_type = pixel_type + self.default_pixel_value = default_pixel_value + + +
[docs] def resample_image(self, + image: sitk.Image, + input_output_space_dict: dict, + reference_image: sitk.Image = None, + transform: sitk.Transform = None, + *args, **kwargs) -> sitk.Image: + + # if image is None: + # image = input_output_space_dict.get('input_image', None) + # if image is None: + # image = input_output_space_dict.get('image', None) + # if image is None: + # raise Exception('No image was provided.') + + output_size = input_output_space_dict['output_size'] + output_spacing = input_output_space_dict['output_spacing'] + output_origin = input_output_space_dict['output_origin'] + output_direction = input_output_space_dict['output_direction'] + + sitk_interpolator = get_sitk_interpolator(self.interpolator) + + if self.default_pixel_value is None: + default_value_filter = sitk.MinimumMaximumImageFilter() + default_value_filter.Execute(image) + default_pixel_value = default_value_filter.GetMinimum() + else: + default_pixel_value = self.default_pixel_value + + resample_filter = sitk.ResampleImageFilter() + + if reference_image is not None: + resample_filter.SetReferenceImage(reference_image) + + else: + resample_filter.SetOutputSpacing(output_spacing) + resample_filter.SetOutputOrigin(output_origin) + resample_filter.SetOutputDirection(output_direction) + resample_filter.SetSize(output_size) + + resample_filter.SetDefaultPixelValue(default_pixel_value) + + if transform is None: + resample_filter.SetTransform(sitk.AffineTransform(self.dim)) + + else: + resample_filter.SetTransform(transform) + + resample_filter.SetInterpolator(sitk_interpolator) + + if self.pixel_type is not None: + sitk_pix_type = get_simpleitk_pix_type(self.pixel_type) + resample_filter.SetOutputPixelType(sitk_pix_type) + + resampled_image = resample_filter.Execute(image) + + return resampled_image
+ + + +
[docs] def get_images(self, + images: Union[List[sitk.Image], Tuple[sitk.Image, ...], sitk.Image], + input_output_space_dict: dict, + + reference_image: sitk.Image = None, + transform: sitk.Transform = None, + *args, **kwargs + ): + + + if isinstance(images, (list, tuple)): + return [self.resample_image(image, input_output_space_dict, reference_image, transform, *args, **kwargs) for image in images] + + else: + return self.resample_image(images, input_output_space_dict, reference_image, transform, *args, **kwargs)
+ +
[docs] def get_resampled_images(self, + image: Union[List[sitk.Image], Tuple[sitk.Image, ...], sitk.Image], + input_output_space_dict: dict, + reference_image: sitk.Image = None, + transform: sitk.Transform = None, + *args, **kwargs + ) -> Union[List[sitk.Image], Tuple[sitk.Image, ...], sitk.Image]: + + output_image_sitk = self.get_images(image, input_output_space_dict, + reference_image, transform, + *args, **kwargs) + + if self.post_processing_sitk is not None: + if isinstance(self.post_processing_sitk, (list, tuple)): + for post_processing_sitk in self.post_processing_sitk: + output_image_sitk = post_processing_sitk(output_image_sitk) + + else: + output_image_sitk = self.post_processing_sitk(output_image_sitk) + + + return output_image_sitk
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/change_image_gamma.html b/_modules/medipt/transforms/intensity/change_image_gamma.html new file mode 100644 index 0000000..54167e8 --- /dev/null +++ b/_modules/medipt/transforms/intensity/change_image_gamma.html @@ -0,0 +1,144 @@ + + + + + + medipt.transforms.intensity.change_image_gamma — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.change_image_gamma

+import numpy as np
+from ...utils import random_uniform_float
+from typing import Union, Tuple, List
+
+
[docs]def change_gamma_unnormalized(img, l): + min_value = np.min(img) + max_value = np.max(img) + input_range = (min_value, max_value) + range_0_1 = (0, 1) + normalized = scale(img, input_range, range_0_1) + normalized = change_gamma(normalized, l) + return scale(normalized, range_0_1, input_range)
+ + +
[docs]def change_gamma(img, l): + return np.power(img, l)
+ + +
[docs]def scale(img, old_range, new_range): + shift = -old_range[0] + new_range[0] * (old_range[1] - old_range[0]) / (new_range[1] - new_range[0]) + scale = (new_range[1] - new_range[0]) / (old_range[1] - old_range[0]) + return (img + shift) * scale
+ + + +
[docs]def random_change_gamma(img, lambda_min=0.5, lambda_max=1.5, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True): + + l = random_uniform_float(lambda_min, lambda_max, + seed=seed, + legacy_random_state=legacy_random_state) + return change_gamma_unnormalized(img, l)
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/clamp_intensity.html b/_modules/medipt/transforms/intensity/clamp_intensity.html new file mode 100644 index 0000000..e4edd82 --- /dev/null +++ b/_modules/medipt/transforms/intensity/clamp_intensity.html @@ -0,0 +1,149 @@ + + + + + + medipt.transforms.intensity.clamp_intensity — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.clamp_intensity

+from typing import Union, Tuple, List
+import numpy as np
+from .intensity_utils_np import clamp_intensity_np
+from .intensity_utils_sitk import clamp_intensity_sitk
+import SimpleITK as sitk
+
+
+
+
[docs]class ClampIntensity: + def __init__(self, + window_min: Union[int, float] = None, + window_max: Union[int, float] = None, + *args, **kwargs): + + self.window_min = window_min + self.window_max = window_max + + + + def __call__(self, image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + + if isinstance(image, np.ndarray): + + return clamp_intensity_np(image, + window_min=self.window_min, + window_max=self.window_max, + *args, **kwargs) + + elif isinstance(image, sitk.Image): + return clamp_intensity_sitk(image, + window_min=self.window_min, + window_max=self.window_max, + *args, **kwargs) + + else: + raise ImportError("image must be either a numpy array or a SimpleITK image.")
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/gaussian_blur.html b/_modules/medipt/transforms/intensity/gaussian_blur.html new file mode 100644 index 0000000..70ec39c --- /dev/null +++ b/_modules/medipt/transforms/intensity/gaussian_blur.html @@ -0,0 +1,179 @@ + + + + + + medipt.transforms.intensity.gaussian_blur — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.gaussian_blur

+from typing import Union, Tuple, List
+import numpy as np
+from ...utils import random_uniform_float
+from ...utils.random_float import initialize_rand_state
+from .intensity_utils_np import gaussian_blur_np
+from .intensity_utils_sitk import gaussian_blur_sitk
+import SimpleITK as sitk
+
+
+
[docs]class GaussianBlur: + def __init__(self, + sigma: Union[int, float], + *args, **kwargs): + + self.sigma = sigma + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + if isinstance(image, np.ndarray): + return gaussian_blur_np(image, self.sigma, *args, **kwargs) + + elif isinstance(image, sitk.Image): + return gaussian_blur_sitk(image, self.sigma, *args, **kwargs) + + else: + raise ImportError("Image must be either a numpy array or a SimpleITK image.")
+ +
[docs]class RandomGaussianBlur: + + def __init__(self, + min_sigma: Union[int, float], + max_sigma: Union[int, float], + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, ** kwargs): + + self.min_sigma = min_sigma + self.max_sigma = max_sigma + self.seed = seed + self.legacy_random_state = legacy_random_state + + self.rand_init = initialize_rand_state(self.seed, self.legacy_random_state) + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + + + sigma = random_uniform_float(low_value=self.min_sigma, high_value=self.max_sigma, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + + if isinstance(image, np.ndarray): + return gaussian_blur_np(image, sigma, *args, **kwargs) + + elif isinstance(image, sitk.Image): + return gaussian_blur_sitk(image, sigma, *args, **kwargs) + + else: + raise ImportError("image must be either a numpy array or a SimpleITK image.")
+ + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/gaussian_noise.html b/_modules/medipt/transforms/intensity/gaussian_noise.html new file mode 100644 index 0000000..0602a1a --- /dev/null +++ b/_modules/medipt/transforms/intensity/gaussian_noise.html @@ -0,0 +1,234 @@ + + + + + + medipt.transforms.intensity.gaussian_noise — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.gaussian_noise

+from typing import Union, Tuple, List
+import SimpleITK as sitk
+import numpy as np
+from ...utils import random_uniform_float
+from ...utils.random_float import initialize_rand_state
+from .intensity_utils_np import gaussian_noise_np
+from .intensity_utils_sitk import gaussian_noise_sitk
+
+
+
[docs]class GaussianNoise: + def __init__(self, + mean: Union[int, float], + sigma: Union[int, float], + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + + self.seed = seed + self.legacy_random_state = legacy_random_state + + self.sigma = sigma + self.mean = mean + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + if isinstance(image, np.ndarray): + return gaussian_noise_np(image, self.mean, self.sigma, *args, **kwargs) + + elif isinstance(image, sitk.Image): + return gaussian_noise_sitk(image, self.mean, self.sigma, *args, **kwargs) + + else: + raise ImportError("Image must be either a numpy array or a SimpleITK image.")
+ + +
[docs]class RandomGaussianNoise: + + def __init__(self, + mean: Union[int, float] = None, + min_mean: Union[int, float] = None, + max_mean: Union[int, float] = None, + + sigma: Union[int, float] = None, + min_sigma: Union[int, float] = None, + max_sigma: Union[int, float] = None, + + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + + self.sigma = sigma + self.min_sigma = min_sigma + self.max_sigma = max_sigma + + self.mean = mean + self.min_mean = min_mean + self.max_mean = max_mean + + self.seed = seed + self.legacy_random_state = legacy_random_state + + self.rand_init = initialize_rand_state(seed=seed, legacy_random_state=legacy_random_state) + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + + + if (self.min_sigma is None) and (self.max_sigma is None) and (self.min_mean is None) and (self.max_mean is None): + raise ValueError("If all min and max values are none, then use GaussianNoise instead") + + + if self.mean is None: + if (self.min_mean is None) and (self.max_mean is None): + raise ValueError("If mean is not provided, min_mean and max_mean must be specified") + + + mean = random_uniform_float(low_value=self.min_mean, high_value=self.max_mean, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + else: + mean = self.mean + + + if self.sigma is None: + if (self.min_sigma is None) and (self.max_sigma is None): + raise ValueError("If sigma is not provided, min_sigma and max_sigma must be specified") + + + sigma = random_uniform_float(low_value=self.min_sigma, high_value=self.max_sigma, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + else: + sigma = self.sigma + + + if isinstance(image, np.ndarray): + return gaussian_noise_np(image, mean, sigma, rand_init=self.rand_init, *args, **kwargs) + + elif isinstance(image, sitk.Image): + + if self.seed is not None: + if self.legacy_random_state: + seed = self.rand_init.get_state()[1][0] + + else: + seed = self.rand_init.__getstate__()['state']['state'] + else: + seed = None + + return gaussian_noise_sitk(image, mean, sigma, seed=seed, *args, **kwargs) + + else: + raise ImportError("image must be either a numpy array or a SimpleITK image.")
+ + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/intensity_utils_np.html b/_modules/medipt/transforms/intensity/intensity_utils_np.html new file mode 100644 index 0000000..6405a9c --- /dev/null +++ b/_modules/medipt/transforms/intensity/intensity_utils_np.html @@ -0,0 +1,236 @@ + + + + + + medipt.transforms.intensity.intensity_utils_np — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.intensity_utils_np

+import SimpleITK as sitk
+import numpy as np
+from scipy.ndimage import gaussian_filter
+from typing import Union, Tuple, List, Any, Callable, Optional
+from types import ModuleType
+
+
+
[docs]def clamp_intensity_np(image: np.ndarray, + window_min: Union[int, float] = None, + window_max: Union[int, float] = None, + image_min: Union[int, float] = None, + image_max: Union[int, float] = None, + *args, **kwargs) -> np.ndarray: + + + if (window_min is None) and (window_max is None): + raise ValueError('window_min and window_max cannot both be None.') + + if image_min is None or image_max is None: + if image_min is None: + image_min = image.min() + if image_max is None: + image_max = image.max() + + if window_min is None: + window_min = image_min + if window_max is None: + window_max = image_max + + clamped_image = np.clip(image, window_min, window_max) + + return clamped_image
+ + + +
[docs]def shift_scale_intensity_np(image: np.ndarray, + shift: Union[int, float] = None, + scale: Union[int, float] = None, + *args, **kwargs) -> np.ndarray: + + shifted_image = image + shift + rescaled_image = shifted_image * scale + + return rescaled_image
+ + + +
[docs]def rescale_intensity_np(image: np.ndarray, + output_min: Union[int, float] = None, + output_max: Union[int, float] = None, + *args, **kwargs) -> np.ndarray: + + + if (output_min is None) or (output_max is None): + if output_min is None: + output_min = image.min() + if output_max is None: + output_max = image.min() + else: + raise ValueError('Need to provide output minimum and/or output maximum.') + + input_min = image.min() + input_max = image.max() + + rescaled_image = (image - input_min) * (output_max - output_min) / (input_max - input_min) + output_max + + return rescaled_image
+ +
[docs]def rescale_intensity_window_np(image: np.ndarray, + input_min: Union[int, float] = None, + input_max: Union[int, float] = None, + output_min: Union[int, float] = None, + output_max: Union[int, float] = None, + *args, **kwargs) -> np.ndarray: + + if input_min is None: + input_min = image.min() + + if input_max is None: + input_max = image.max() + + if (output_min is None) and (output_max is None): + raise ValueError('Need to provide output minimum and/or output maximum.') + else: + if output_min is None: + output_min = input_min + if output_max is None: + output_max = input_max + + + rescaled_image = (image - input_min) * (output_max - output_min) / (input_max - input_min) + output_min + + rescaled_image = np.clip(rescaled_image, a_min=output_min, a_max=output_max) + + return rescaled_image
+ + + + +
[docs]def gaussian_blur_np(image: np.ndarray, + sigma: Union[int, float], + *args, **kwargs) -> np.ndarray: + output_image = gaussian_filter(image, sigma=sigma) + + return output_image
+ + + +
[docs]def gaussian_noise_np(image: np.ndarray, + mean: Union[int, float], + sigma: Union[int, float], + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + *args, **kwargs) -> np.ndarray: + + gaussian = rand_init.normal(mean, sigma, image.shape) + output_image = image + gaussian + return output_image
+ + +
[docs]def change_image_gamma_np(image: np.ndarray, + gamma: Union[int, float], + *args, **kwargs) -> np.ndarray: + + output_image = np.power(image, gamma) + return output_image
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/intensity_utils_sitk.html b/_modules/medipt/transforms/intensity/intensity_utils_sitk.html new file mode 100644 index 0000000..444f80a --- /dev/null +++ b/_modules/medipt/transforms/intensity/intensity_utils_sitk.html @@ -0,0 +1,313 @@ + + + + + + medipt.transforms.intensity.intensity_utils_sitk — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.intensity_utils_sitk

+import SimpleITK as sitk
+import numpy as np
+from typing import Union, Tuple, List
+
+
+
[docs]def min_max_intensity_sitk(image: sitk.Image, + *args, **kwargs) -> Tuple[float, float]: + + min_max_filter = sitk.MinimumMaximumImageFilter() + min_max_filter.Execute(image) + + image_min = min_max_filter.GetMinimum() + image_max = min_max_filter.GetMaximum() + + return image_min, image_max
+ + + +
[docs]def clamp_intensity_sitk(image: sitk.Image, + window_min: Union[int, float] = None, + window_max: Union[int, float] = None, + image_min: Union[int, float] = None, + image_max: Union[int, float] = None, + *args, **kwargs) -> sitk.Image: + + + if (window_min is None) and (window_max is None): + raise ValueError('window_min and window_max cannot both be None.') + + if image_min is None or image_max is None: + image_min_max = min_max_intensity_sitk(image) + + if image_min is None: + image_min = image_min_max[0] + if image_max is None: + image_max = image_min_max[1] + + if window_min is None: + window_min = image_min + if window_max is None: + window_max = image_max + + clamp_filter = sitk.ClampImageFilter() + + clamp_filter.SetLowerBound(window_min) + clamp_filter.SetUpperBound(window_max) + + clamped_image = clamp_filter.Execute(image) + + return clamped_image
+ + + +
[docs]def shift_scale_intensity_sitk(image: sitk.Image, + shift: Union[int, float] = None, + scale: Union[int, float] = None, + *args, **kwargs) -> sitk.Image: + + shift_scale_filter = sitk.ShiftScaleImageFilter() + shift_scale_filter.SetShift(shift) + shift_scale_filter.SetScale(scale) + shifted_scaled_image = shift_scale_filter.Execute(image) + + return shifted_scaled_image
+ + +
[docs]def rescale_intensity_sitk(image: sitk.Image, + output_min: Union[int, float] = None, + output_max: Union[int, float] = None, + *args, **kwargs) -> sitk.Image: + + + if (output_min is None) and (output_max is None): + raise ValueError('Need to provide output minimum and/or output maximum.') + else: + image_min_max = min_max_intensity_sitk(image) + if output_min is None: + output_min = image_min_max[0] + if output_max is None: + output_max = image_min_max[1] + + + # if (output_min is None) or (output_max is None): + # image_min_max = min_max_intensity_sitk(image) + # if output_min is None: + # output_min = image_min_max[0] + # if output_max is None: + # output_max = image_min_max[1] + # else: + # raise ValueError('Need to provide output minimum and/or output maximum.') + + + rescale_filter = sitk.RescaleIntensityImageFilter() + rescale_filter.SetOutputMinimum(output_min) + rescale_filter.SetOutputMaximum(output_max) + + rescaled_image = rescale_filter.Execute(image) + + return rescaled_image
+ +
[docs]def rescale_intensity_window_sitk(image: sitk.Image, + # output_min: Union[int, float] = None, + # output_max: Union[int, float] = None, + input_min: Union[int, float] = None, + input_max: Union[int, float] = None, + output_min: Union[int, float] = None, + output_max: Union[int, float] = None, + *args, **kwargs) -> sitk.Image: + + image_min_max = min_max_intensity_sitk(image) + + if input_min is None: + input_min = image_min_max[0] + + if input_max is None: + input_max = image_min_max[1] + + + if (output_min is None) and (output_max is None): + raise ValueError('Need to provide output minimum and/or output maximum.') + else: + if output_min is None: + output_min = input_min + if output_max is None: + output_max = input_max + + + + + rescale_filter = sitk.IntensityWindowingImageFilter() + + rescale_filter.SetOutputMaximum(output_max) + rescale_filter.SetOutputMinimum(output_min) + + rescale_filter.SetWindowMaximum(input_max) + rescale_filter.SetWindowMinimum(input_min) + + + rescaled_image = rescale_filter.Execute(image) + + return rescaled_image
+ + + + +
[docs]def gaussian_blur_sitk(image: sitk.Image, + sigma: Union[int, float], + *args, **kwargs) -> sitk.Image: + + image_default_pixel_type = image.GetPixelID() + + gaussian_filter = sitk.SmoothingRecursiveGaussianImageFilter() + gaussian_filter.SetSigma(sigma) + + rescast_filter = sitk.CastImageFilter() + rescast_filter.SetOutputPixelType(sitk.sitkFloat64) + image = rescast_filter.Execute(image) + + output_image = gaussian_filter.Execute(image) + + if image_default_pixel_type != sitk.sitkFloat64: + output_image = sitk.Cast(output_image, image_default_pixel_type) + + return output_image
+ + + +
[docs]def gaussian_noise_sitk(image: sitk.Image, + mean: Union[int, float], + sigma: Union[int, float], + seed: int = None, + *args, **kwargs) -> sitk.Image: + + image_default_pixel_type = image.GetPixelID() + + gaussian_noise_filter = sitk.AdditiveGaussianNoiseImageFilter() + gaussian_noise_filter.SetMean(mean) + gaussian_noise_filter.SetStandardDeviation(sigma) + + if seed is not None: + gaussian_noise_filter.SetSeed(seed) + + rescast_filter = sitk.CastImageFilter() + rescast_filter.SetOutputPixelType(sitk.sitkFloat64) + image = rescast_filter.Execute(image) + + output_image = gaussian_noise_filter.Execute(image) + + if image_default_pixel_type != sitk.sitkFloat64: + output_image = sitk.Cast(output_image, image_default_pixel_type) + + return output_image
+ + +
[docs]def change_image_gamma_sitk(image: sitk.Image, + gamma: Union[int, float], + *args, **kwargs) -> sitk.Image: + + exp_image_filter = sitk.PowImageFilter() + output_image = exp_image_filter.Execute(image, gamma) + + return output_image
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/rescale_intensity.html b/_modules/medipt/transforms/intensity/rescale_intensity.html new file mode 100644 index 0000000..4df139b --- /dev/null +++ b/_modules/medipt/transforms/intensity/rescale_intensity.html @@ -0,0 +1,149 @@ + + + + + + medipt.transforms.intensity.rescale_intensity — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.rescale_intensity

+from typing import Union, Tuple, List
+import SimpleITK as sitk
+import numpy as np
+from .intensity_utils_np import rescale_intensity_np
+from .intensity_utils_sitk import rescale_intensity_sitk
+
+
+
+
[docs]class RescaleIntensity: + def __init__(self, + new_min: Union[int, float] = None, + new_max: Union[int, float] = None, + *args, **kwargs): + + + self.new_min = new_min + self.new_max = new_max + + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + + if isinstance(image, np.ndarray): + return rescale_intensity_np(image, + output_min=self.new_min, + output_max=self.new_max, + *args, **kwargs) + + elif isinstance(image, sitk.Image): + return rescale_intensity_sitk(image, + output_min=self.new_min, + output_max=self.new_max, + *args, **kwargs) + + else: + raise ImportError("image must be either a numpy array or a SimpleITK image.")
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/intensity/shift_scale_intensity.html b/_modules/medipt/transforms/intensity/shift_scale_intensity.html new file mode 100644 index 0000000..c54971b --- /dev/null +++ b/_modules/medipt/transforms/intensity/shift_scale_intensity.html @@ -0,0 +1,272 @@ + + + + + + medipt.transforms.intensity.shift_scale_intensity — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.intensity.shift_scale_intensity

+from typing import Union, Tuple, List
+import numpy as np
+from .intensity_utils_sitk import shift_scale_intensity_sitk
+from .intensity_utils_np import shift_scale_intensity_np
+from ...utils import random_uniform_float
+from ...utils.random_float import initialize_rand_state
+import SimpleITK as sitk
+import warnings
+
+
+# class ShiftScaleIntensity:
+#     def __init__(self,
+#                  shift: Union[int, float] = None,
+#                  scale: Union[int, float] = None,
+#                  *args, **kwargs):
+#
+#         self.shift = shift
+#         self.scale = scale
+#
+#
+#     def __call__(self,
+#                  image: Union[np.ndarray, sitk.Image],
+#                  *args, **kwargs) -> Union[np.ndarray, sitk.Image]:
+#
+#         if isinstance(image, np.ndarray):
+#             output_image = shift_scale_intensity_np(image,
+#                                                     shift=self.shift,
+#                                                     scale=self.scale,
+#                                                     *args, **kwargs)
+#         elif isinstance(image, sitk.Image):
+#             output_image = shift_scale_intensity_sitk(image,
+#                                                       shift=self.shift,
+#                                                       scale=self.scale,
+#                                                       *args, **kwargs)
+#
+#         else:
+#             raise ImportError("image must be either a numpy array or a SimpleITK image.")
+#
+#         return output_image
+
+
+
+
[docs]class ShiftScaleIntensity: + + def __init__(self, + shift: Union[int, float] = None, + scale: Union[int, float] = None, + input_min: Union[int, float] = None, + input_max: Union[int, float] = None, + output_min: Union[int, float] = None, + output_max: Union[int, float] = None, + random_shift: Union[int, float] = None, + random_scale: Union[int, float] = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, ** kwargs): + + self.shift = shift + self.scale = scale + + + self.input_min = input_min + self.input_max = input_max + self.output_min = output_min + self.output_max = output_max + + self.random_shift = random_shift + self.random_scale = random_scale + + + self.seed = seed + self.legacy_random_state = legacy_random_state + + self.rand_init = initialize_rand_state(self.seed, self.legacy_random_state) + + + def __call__(self, + image: Union[np.ndarray, sitk.Image], + *args, **kwargs) -> Union[np.ndarray, sitk.Image]: + + + if (self.shift is None) and (self.scale is None) and (self.input_min is None) and (self.input_max is None) and (self.output_min is None) and (self.output_max is None): + raise ValueError("At least one of shift, scale, input_min, input_max, output_min, output_max must be provided.") + + + if ((self.shift is None) and (self.scale is None)) and ((self.input_min is None) and (self.input_max is None) and (self.output_min is None) and (self.output_max is None)): + raise ValueError("Either shift and scale or input_min, input_max, output_min, output_max must be provided.") + + if (self.shift is not None) and (self.scale is not None) and (self.input_min is not None) and (self.input_max is not None) and (self.output_min is not None) and (self.output_max is not None): + warnings.warn("Mixing both shift and scale with input_min, input_max, output_min, output_max. Input and output values will be set to 'None'.") + self.input_min = None + self.input_max = None + self.output_min = None + self.output_max = None + + + if (self.shift is None) and (self.scale is None) and (self.input_min is not None) and (self.input_max is not None) and (self.output_min is not None) and (self.output_max is not None): + self.shift = -self.input_min + self.output_min * (self.input_max - self.input_min) / (self.output_max - self.output_min) + self.scale = (self.output_max - self.output_min) / (self.input_max - self.input_min) + + + + + if isinstance(image, np.ndarray): + output_image = shift_scale_intensity_np(image, + shift=self.shift, + scale=self.scale, + *args, **kwargs) + + elif isinstance(image, sitk.Image): + output_image = shift_scale_intensity_sitk(image, + shift=self.shift, + scale=self.scale, + *args, **kwargs) + + else: + raise ImportError("image must be either a numpy array or a SimpleITK image.") + + + if (self.random_shift is not None) or (self.random_scale is not None): + + if self.random_shift: + random_shift = random_uniform_float(low_value=-self.random_shift, + high_value=self.random_shift, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + else: + random_shift = 0 + + if self.random_scale: + random_scale = random_uniform_float(low_value=-self.random_scale, + high_value=self.random_scale, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + else: + random_scale = 1 + + random_scale = 1 + random_scale + + if isinstance(image, np.ndarray): + output_image = shift_scale_intensity_np(output_image, + shift=random_shift, + scale=random_scale, + *args, **kwargs) + + elif isinstance(image, sitk.Image): + output_image = shift_scale_intensity_sitk(output_image, + shift=random_shift, + scale=random_scale, + *args, **kwargs) + + return output_image + + else: + + return output_image
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/composite_transform.html b/_modules/medipt/transforms/spatial/composite_transform.html new file mode 100644 index 0000000..5398696 --- /dev/null +++ b/_modules/medipt/transforms/spatial/composite_transform.html @@ -0,0 +1,200 @@ + + + + + + medipt.transforms.spatial.composite_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.composite_transform

+import SimpleITK as sitk
+import numpy as np
+from typing import Union, Tuple, List
+from .spatial_transform import SpatialTransform
+from .elastic_deformation_transform import ElasticDeformation
+
+
[docs]def composite_transform(transforms: List[Union[sitk.AffineTransform, sitk.BSplineTransform, sitk.DisplacementFieldTransform]], + dim: int = 3): + + if sitk.Version_MajorVersion() == 1: + compos = sitk.Transform(dim, sitk.sitkIdentity) + for transformation in transforms: + compos.AddTransform(transformation) + else: + compos = sitk.CompositeTransform(transforms) + + + return compos
+ + + +
[docs]class CompositeTransform: + def __init__(self, + *args, **kwargs): + + self.transforms = [] + + +
[docs] def add_transforms(self, + transform: Union[List[Union[SpatialTransform, sitk.Transform]], + Tuple[Union[SpatialTransform, sitk.Transform], ...], + Union[SpatialTransform, sitk.Transform]]): + + if isinstance(transform, (tuple, list)): + self.transforms.extend(transform) + + else: + self.transforms.append(transform)
+ +
[docs] def create_composite(self, dim: int = 3) -> sitk.Transform: + compos = sitk.CompositeTransform(dim) + for transform in self.transforms: + if isinstance(transform, SpatialTransform): + sitk_transform = transform.transform + compos.AddTransform(sitk_transform) + else: + compos.AddTransform(transform.transform) + + return compos
+ +
[docs] def create_inverse_composite(self, dim: int = 3, + use_displacement_field: bool = False) -> sitk.CompositeTransform: + compos = sitk.CompositeTransform(dim) + + for transform in self.transforms[::-1]: + if isinstance(transform, SpatialTransform): + + if isinstance(transform, ElasticDeformation): + if use_displacement_field: + transform.get_inverted_transform_from_displacement() + sitk_inverse_transform = transform.inverted_transform_from_displacement + + else: + transform.get_inverse_transform() + sitk_inverse_transform = transform.inverse_transform + + else: + transform.get_inverse_transform() + sitk_inverse_transform = transform.inverse_transform + + # if use_displacement_field: + # transform.get_inverted_transform_from_displacement() + # sitk_inverse_transform = transform.inverted_transform_from_displacement + # + # else: + # transform.get_inverse_transform() + # sitk_inverse_transform = transform.inverse_transform + + + compos.AddTransform(sitk_inverse_transform) + + else: + if use_displacement_field: + raise Warning("The use_displacement_field option is not implemented for SimpleITK transforms.") + compos.AddTransform(transform.GetInverse()) + + return compos
+ + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/elastic_deformation_transform.html b/_modules/medipt/transforms/spatial/elastic_deformation_transform.html new file mode 100644 index 0000000..d7efc3a --- /dev/null +++ b/_modules/medipt/transforms/spatial/elastic_deformation_transform.html @@ -0,0 +1,476 @@ + + + + + + medipt.transforms.spatial.elastic_deformation_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.elastic_deformation_transform

+from typing import Union, Tuple, List
+from ...utils import random_uniform_float
+import SimpleITK as sitk
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+
+
+
[docs]class ElasticDeformation(SpatialTransform): + """ + Rotation transformation base class. + """ + + def __init__(self, + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + """ + Initializer + :param dim: The dimension. + :param used_dimensions: Boolean list of which dimension indizes to use for the transformation. + :param args: Arguments passed to super init. + :param kwargs: Keyword arguments passed to super init. + """ + + + super(ElasticDeformation, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + self.spline_params = None + self.transform = None + self.inverse_transform = None + self.transform_created = False + + self.displacement_field = None + self.inverted_displacement_field = None + self.inverted_transform_from_displacement = None + + self.spline_order = None + self.num_grid_points = None + + self.image_size = None + self.image_spacing = None + self.image_origin = None + self.image_direction = None + + + + def _get_deform_transform(self, + spline_params: List[float], + *args, **kwargs) -> sitk.BSplineTransform: + + + # direction_reshape = np.reshape(self.image_direction, (self.dim, self.dim)) + # physical_dimensions = np.matmul(direction_reshape * self.image_spacing, self.image_size) + + physical_dimensions = np.array(self.image_spacing) * np.array(self.image_size) + physical_dimensions = physical_dimensions.astype('float') + + mesh_size = [grid_node - self.spline_order for grid_node in self.num_grid_points] + t = sitk.BSplineTransform(self.dim, self.spline_order) + t.SetTransformDomainOrigin(self.image_origin) + t.SetTransformDomainMeshSize(mesh_size) + t.SetTransformDomainPhysicalDimensions(physical_dimensions) + t.SetTransformDomainDirection(self.image_direction) + + t.SetParameters(spline_params) + + return t + + + + def _get_transform( + self, + spline_params: Union[List[float], np.ndarray], + image_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_direction: Union[List[Union[int, float]], Tuple[Union[int, float]]] = None, + + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + # max_deformation_displacement: Union[List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray] = 25, + spline_order: int = 3, + + *args, **kwargs): + + self.spline_params = spline_params + + self.spline_order = spline_order + + if isinstance(num_grid_points, (int, float)): + num_grid_points = tuple([int(num_grid_points)] * self.dim) + + else: + assert len(num_grid_points) == self.dim, 'Make sure dimensions align for num_grid_points' + + self.num_grid_points = num_grid_points + + + image_params = self.get_image_params(image_size=image_size, + image_spacing=image_spacing, + image_origin=image_origin, + image_direction=image_direction, + *args, **kwargs) + + self.image_size = image_params[0] + self.image_spacing = image_params[1] + self.image_origin = image_params[2] + self.image_direction = image_params[3] + + + if isinstance(spline_params, np.ndarray): + spline_params = spline_params.flatten().tolist() + + self.transform = self._get_deform_transform(spline_params, *args, **kwargs) + + +
[docs] def get_transform(self, + *args, **kwargs): + + self._get_transform(*args, **kwargs)
+ + +
[docs] def get_inverse_transform(self, *args, **kwargs): + ''' + This determines the inverse transform for the elastic deformation. + + Note: this is not suitable for proper resampling the transformed image back to the original state, but is + intended to be used with coordinate transforms. For image resampling, use the inverted deformation field. + :param args: + :param kwargs: + :return: + ''' + + if self.transform is not None: + if isinstance(self.spline_params, np.ndarray): + spline_params_inv = -1 * self.spline_params + else: + spline_params_inv = [-1 * param for param in self.spline_params] + + if isinstance(spline_params_inv, np.ndarray): + spline_params_inv = spline_params_inv.flatten().tolist() + + self.inverse_transform = self._get_deform_transform(spline_params_inv, *args, **kwargs) + + # self.t_inv = t_inv + + else: + raise ValueError('No transform found. Call get_transform first.')
+ + + +
[docs] def get_displacement_field(self, *args, **kwargs): + + if self.transform is not None: + + displacement_field = sitk.TransformToDisplacementField(self.transform, + size=self.image_size, + outputSpacing=self.image_spacing, + outputDirection=self.image_direction, + outputOrigin=self.image_origin) + + self.displacement_field = displacement_field + else: + raise ValueError('No transform found. Call get_transform first.')
+ + +
[docs] def get_inverted_displacement_field(self, *args, **kwargs): + + if self.displacement_field is None: + self.get_displacement_field() + + self.inverted_displacement_field = sitk.InvertDisplacementField(self.displacement_field)
+ + +
[docs] def get_inverted_transform_from_displacement(self): + + if self.inverted_displacement_field is None: + self.get_inverted_displacement_field() + + self.inverted_transform_from_displacement = sitk.DisplacementFieldTransform(self.inverted_displacement_field)
+ + + +
[docs]class ElasticDeformationInputImage(ElasticDeformation): + +
[docs] def get_transform_on_input( + self, + spline_params: Union[List[float], np.ndarray], + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + spline_order: int = 3, + *args, **kwargs): + + + self.get_image_params(*args, **kwargs) + + + self.get_transform(spline_params=spline_params, + num_grid_points=num_grid_points, + spline_order=spline_order, + image_size=self.input_size, + image_spacing=self.input_spacing, + image_origin=self.input_origin, + image_direction=self.input_direction, + *args, **kwargs)
+ + # return t + + +
[docs]class ElasticDeformationOutputImage(ElasticDeformation): + +
[docs] def get_transform_on_output( + self, + spline_params: Union[List[float], np.ndarray], + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + spline_order: int = 3, + *args, **kwargs): + + self.get_image_params(*args, **kwargs) + + self.get_transform(spline_params=spline_params, + num_grid_points=num_grid_points, + spline_order=spline_order, + image_size=self.output_size, + image_spacing=self.output_spacing, + image_origin=self.output_size, + image_direction=self.output_direction, + *args, **kwargs)
+ + # return t + + +
[docs]class RandomElasticDeformation(ElasticDeformation): + + def __init__(self, + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + + + super(RandomElasticDeformation, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + + +
[docs] def get_random_spline_params( + self, + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray] = (6, 6, 6), + max_deformation_displacement: Union[List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray] = (25, 25, 25), + *args, **kwargs, ) -> np.ndarray: + + output_size = *num_grid_points, self.dim + + spline_params = random_uniform_float(-1, 1, + output_size=output_size, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + for dimension in range(self.dim): + spline_params[..., dimension] *= max_deformation_displacement[dimension] + + + + + + + + + # if isinstance(max_deformation_displacement, (list, tuple)): + # spline_params = [] + # for v in max_deformation_displacement: + # for i in range(int(np.prod(num_grid_points))): + # spline_params.append(random_uniform_float(-v, v, seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # rand_init=self.rand_init)) + + + + return spline_params
+ + +
[docs] def get_random_transform( + self, + image_size: Union[int, float, List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray], + image_spacing: Union[int, float, List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray], + image_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...], np.ndarray] = None, + image_direction: Union[List[Union[int, float]], Tuple[Union[int, float]], np.ndarray] = None, + + + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + max_deformation_displacement: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 25, + + + spline_order: int = 3, + + *args, **kwargs): + + if isinstance(num_grid_points, (int, float)): + num_grid_points = [num_grid_points] * self.dim + + if isinstance(max_deformation_displacement, (int, float)): + max_deformation_displacement = [max_deformation_displacement] * self.dim + + self.spline_params = self.get_random_spline_params(num_grid_points, max_deformation_displacement, + *args, **kwargs) + + + self.get_transform(self.spline_params, + image_size=image_size, image_spacing=image_spacing, + image_origin=image_origin, image_direction=image_direction, + num_grid_points=num_grid_points, + max_deformation_displacement=max_deformation_displacement, + spline_order=spline_order, + *args, **kwargs)
+ + + # return self.t + + + +
[docs]class RandomElasticDeformationTransformInputImage(RandomElasticDeformation): +
[docs] def get_random_transform_on_input( + self, + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + max_deformation_displacement: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 25, + spline_order: int = 3, + *args, **kwargs): + + self.get_image_params(*args, **kwargs) + + self.get_random_transform(num_grid_points=num_grid_points, + max_deformation_displacement=max_deformation_displacement, + spline_order=spline_order, + image_size=self.input_size, + image_spacing=self.input_spacing, + image_origin=self.input_origin, + image_direction=self.input_direction, + *args, **kwargs)
+ + # return t + + +
[docs]class RandomElasticDeformationTransformOutputImage(RandomElasticDeformation): +
[docs] def get_random_transform_on_output( + self, + num_grid_points: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 6, + max_deformation_displacement: Union[List[Union[int, float]], Tuple[Union[int, float], ...], int, float] = 25, + spline_order: int = 3, + *args, **kwargs): + + self.get_image_params(*args, **kwargs) + + self.get_random_transform(num_grid_points=num_grid_points, + max_deformation_displacement=max_deformation_displacement, + spline_order=spline_order, + image_size=self.output_size, + image_spacing=self.output_spacing, + image_origin=self.output_size, + image_direction=self.output_direction, + *args, **kwargs)
+ + # return t +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/flipping_transform.html b/_modules/medipt/transforms/spatial/flipping_transform.html new file mode 100644 index 0000000..b0adda7 --- /dev/null +++ b/_modules/medipt/transforms/spatial/flipping_transform.html @@ -0,0 +1,238 @@ + + + + + + medipt.transforms.spatial.flipping_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.flipping_transform

+from typing import Union, Tuple, List
+import SimpleITK as sitk
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+from ...utils import random_binomial
+
+
+
[docs]class FlippingTransform(SpatialTransform): + + def _get_transform(self, + flip_axes: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + + + + if isinstance(flip_axes, (tuple, list, np.ndarray)): + current_flip_axes = [] + if len(flip_axes) > 1: + if len(flip_axes) != self.dim: + raise ValueError(f'flip axes must be a tuple or list of length {self.dim}.') + + for flip_axis in flip_axes: + + current_flip_axes.append(bool(flip_axis)) + + elif isinstance(flip_axes, (int, float, np.integer, np.floating, np.bool_, bool)): + current_flip_axes = [bool(flip_axes)] * self.dim + + else: + raise ValueError('flip axes must be tuples, lists, or numbers.') + + + + self.transform = sitk.AffineTransform(self.dim) + + scale_factors = [-1.0 if f else 1.0 for f in current_flip_axes] + + self.transform.Scale(scale_factors) + +
[docs] def get_transform(self, + flip_axes: Union[List[float], Tuple[float, ...], float], + *args, **kwargs + ): + + self._get_transform(flip_axes, *args, **kwargs)
+ + + +
[docs]class RandomFlipping(FlippingTransform): + +
[docs] def get_random_transform(self, + flip_axes: Union[ + List[Union[int, float, bool]], + Tuple[Union[int, float, bool], ...], + Union[int, float, bool, np.integer, np.floating], + np.ndarray], + *args, **kwargs, + ): + + if isinstance(flip_axes, (tuple, list, np.ndarray)): + + if isinstance(flip_axes, np.ndarray): + probability = flip_axes * 0.5 + + elif isinstance(flip_axes, (list, tuple)): + probability = 0.5 * np.array(flip_axes) + + else: + raise ValueError('flip axes must be tuples, lists, or numbers.') + + elif isinstance(flip_axes, (int, float, np.integer, np.floating, np.bool_, bool)): + + probability = 0.5 * flip_axes + + else: + raise ValueError('flip axes must be tuples, lists, or numbers.') + + current_flip_axis = random_binomial(n=1, p=probability, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + self._get_transform(current_flip_axis, *args, **kwargs)
+ + + + + + + + + + # + # if isinstance(flip_axes, (tuple, list, np.ndarray)): + # current_flip_axes = [] + # if len(flip_axes) > 1: + # if len(flip_axes) != self.dim: + # raise ValueError(f'flip axes must be a tuple or list of length {self.dim}.') + # + # for flip_axis in flip_axes: + # + # if flip_axis == 1: + # current_flip_axis = random_binomial(n=1, p=0.5, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # rand_init=self.rand_init) + # else: + # current_flip_axis = 0 + # + # current_flip_axes.append(bool(current_flip_axis)) + # + # elif isinstance(flip_axes, (int, float, np.integer, np.floating, np.bool_, bool)): + # if flip_axes == 1: + # current_flip_axis = random_binomial(n=1, p=0.5, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # rand_init=self.rand_init) + # + # else: + # current_flip_axis = 0 + # current_flip_axes = [bool(current_flip_axis)] * self.dim + # + # else: + # raise ValueError('flip axes must be tuples, lists, or numbers.') + # + # self._get_transform(current_flip_axes, *args, **kwargs) +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/random_affine_transform.html b/_modules/medipt/transforms/spatial/random_affine_transform.html new file mode 100644 index 0000000..d1eb65e --- /dev/null +++ b/_modules/medipt/transforms/spatial/random_affine_transform.html @@ -0,0 +1,198 @@ + + + + + + medipt.transforms.spatial.random_affine_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.random_affine_transform

+from typing import Union, Tuple, List
+from types import ModuleType
+from ...utils import random_uniform_float
+
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+
+
+
+
[docs]class RandomAffineTransform(SpatialTransform): + + def __init__(self, + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + *args, **kwargs + ): + + + super(RandomAffineTransform, self).__init__(dim, used_dimensions, seed, legacy_random_state, rand_init, *args, **kwargs) + + + self.min_range = None + self.max_range = None + + + + def _get_random_transform(self, + min_range: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + max_range: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + value_offset: Union[int, float] = None, + uniform: bool = False, + transform_dict: dict = None, + *args, **kwargs): + + self.min_range = min_range + self.max_range = max_range + + + if isinstance(min_range, (tuple, list, np.ndarray)): + assert isinstance(self.max_range, (tuple, list, np.ndarray)), 'both min and max angles must be tuples, lists or np.ndarrays.' + + if len(self.min_range) > 1 or len(self.max_range) > 1: + assert len(self.min_range) == self.dim, f'min angles must be a tuple or list of length {self.dim}.' + assert len(self.max_range) == self.dim, f'max angles must be a tuple or list of length {self.dim}.' + + random_params = random_uniform_float(self.min_range, self.max_range, + seed=self.seed, legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + else: + random_params = random_uniform_float(self.min_range[0], self.max_range[0], output_size=self.dim, + seed=self.seed, legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + + elif isinstance(self.min_range, (int, float, np.ndarray, np.floating, np.integer)): + assert isinstance(self.max_range, (int, float, np.ndarray, np.floating, np.integer)), 'both min and max rotations must be numbers.' + + + if uniform is False: + + random_params = random_uniform_float(self.min_range, self.max_range, output_size=self.dim, + seed=self.seed, legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + else: + random_params = random_uniform_float(self.min_range, self.max_range, + seed=self.seed, legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init) + + random_params = [random_params] * self.dim + + + else: + raise ValueError('min and max offsets must be tuples, lists, or numbers.') + + + if value_offset is not None: + if isinstance(random_params, (list, tuple)): + random_params = [x + value_offset for x in random_params] + elif isinstance(random_params, np.ndarray): + random_params += value_offset + + self._get_transform(random_params, *args, **kwargs)
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/rotation_transform.html b/_modules/medipt/transforms/spatial/rotation_transform.html new file mode 100644 index 0000000..0218d59 --- /dev/null +++ b/_modules/medipt/transforms/spatial/rotation_transform.html @@ -0,0 +1,236 @@ + + + + + + medipt.transforms.spatial.rotation_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.rotation_transform

+from abc import ABC
+from typing import Union, Tuple, List
+from types import ModuleType
+import SimpleITK as sitk
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+from .random_affine_transform import RandomAffineTransform
+
+
+
[docs]class RotationTransform(SpatialTransform): + """ + Rotation transformation base class. + """ + + # def __init__(self, + # dim: int = 3, + # used_dimensions: bool = None, + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + # *args, **kwargs): + # """ + # Initializer + # :param dim: The dimension. + # :param used_dimensions: Boolean list of which dimension indizes to use for the transformation. + # :param args: Arguments passed to super init. + # :param kwargs: Keyword arguments passed to super init. + # """ + # + # + # super(RotationTransform, self).__init__(dim, used_dimensions, seed, legacy_random_state, rand_init, *args, **kwargs) + + + def _get_transform(self, + angles: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + + """ + Returns the sitk transform based on the given parameters. + :param dim: The dimension. + :param angles: List of angles for each dimension (in radians). + :return: The sitk.AffineTransform(). + """ + if not isinstance(angles, (list, tuple)): + angles = [angles] + assert isinstance(angles, (list, tuple)), 'Angles parameter must be a list of floats, one for each dimension.' + + assert len(angles) in [1, self.dim], 'Angles must be a list of length 1 for 2D, or 3 for 3D.' + + self.transform = sitk.AffineTransform(self.dim) + + if isinstance(angles, (tuple, list)): + + if len(angles) == 1: + # 2D + self.transform.Rotate(0, 1, angle=angles[0]) + + elif len(angles) > 1: + assert len(angles) == self.dim, f'angles must be a list of length {self.dim}.' + + # 3D + # rotate about x axis + self.transform.Rotate(1, 2, angle=angles[0]) + # rotate about y axis + self.transform.Rotate(0, 2, angle=angles[1]) + # rotate about z axis + self.transform.Rotate(0, 1, angle=angles[2]) + + + elif isinstance(angles, (int, float, np.ndarray)): + self.transform.Rotate(0, 1, angle=angles) + + # return self.t + + a = 1 + + +
[docs] def get_transform(self, + angles: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + + self._get_transform(angles, *args, **kwargs)
+ + # return t + +
[docs]class RandomRotation(RotationTransform, RandomAffineTransform): + """ + A rotation transformation with random angles (in radian). + """ + # def __init__(self, + # dim: int, + # used_dimensions: bool = None, + # # min_angles: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray, None] = None, + # # max_angles: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray, None] = None, + # + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # + # *args, **kwargs): + # """ + # Initializer. + # :param dim: The dimension. + # :param random_angles: List of random angles per dimension. Random angle is calculated uniformly within [-random_angles[i], random_angles[i]] + # :param args: Arguments passed to super init. + # :param kwargs: Keyword arguments passed to super init. + # """ + # + # + # super(RandomRotation, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + + + +
[docs] def get_random_transform(self, + min_angles: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray, None] = None, + max_angles: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray, None] = None, + transformation_dict: dict = None, + *args, **kwargs): + + + self._get_random_transform(min_angles, max_angles, transformation_dict=transformation_dict, *args, **kwargs)
+ + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/scaling_transform.html b/_modules/medipt/transforms/spatial/scaling_transform.html new file mode 100644 index 0000000..c3d8ad8 --- /dev/null +++ b/_modules/medipt/transforms/spatial/scaling_transform.html @@ -0,0 +1,256 @@ + + + + + + medipt.transforms.spatial.scaling_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.scaling_transform

+from typing import Union, Tuple, List
+from types import ModuleType
+import SimpleITK as sitk
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+from .random_affine_transform import RandomAffineTransform
+
+
+
[docs]class ScalingTransform(SpatialTransform): + """ + Scale transformation base class. + """ + + # def __init__(self, + # dim: int = 3, + # used_dimensions: bool = None, + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + # *args, **kwargs): + # """ + # Initializer + # :param dim: The dimension. + # :param used_dimensions: Boolean list of which dimension indizes to use for the transformation. + # :param args: Arguments passed to super init. + # :param kwargs: Keyword arguments passed to super init. + # """ + # + # super(ScalingTransform, self).__init__(dim, used_dimensions, seed, legacy_random_state, rand_init, *args, **kwargs) + + def _get_transform(self, + scale: Union[List[float], Tuple[float, ...], float, int], + *args, **kwargs): + + + if isinstance(scale, (list, tuple)): + assert len(scale) == self.dim, 'Length of scale must be equal to dim.' + + elif isinstance(scale, (float, int)): + scale = [scale] * self.dim + + else: + raise ValueError('Scale must be a list, tuple, float or int.') + + t = sitk.AffineTransform(self.dim) + t.Scale(scale) + + self.transform = t + + # return t + +
[docs] def get_transform(self, + scale: Union[List[float], Tuple[float, ...], float, int], + *args, **kwargs): + + self._get_transform(scale, *args, **kwargs)
+ +
[docs] def get_scale_transform(self, dim, scale, direction) -> sitk.AffineTransform: + """ + Returns the sitk transform based on the given parameters. + :param dim: The dimension. + :param scale: List of scale factors for each dimension. + :return: The sitk.AffineTransform(). + """ + if isinstance(scale, list) or isinstance(scale, tuple): + assert len(scale) == dim, 'Length of scale must be equal to dim.' + + s = sitk.AffineTransform(dim) + s.Scale(scale) + + scale_matrix = np.array(s.GetMatrix()).reshape([self.dim, self.dim]) + + aff_matrix = np.matmul(np.array(direction).reshape([self.dim, self.dim]), scale_matrix) + s.SetMatrix(aff_matrix.flatten()) + return s
+ + + + +
[docs]class RandomScaling(ScalingTransform, RandomAffineTransform): + + # def __init__(self, + # dim: int, + # used_dimensions: bool = None, + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # + # *args, **kwargs): + # + # super(RandomScaling, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + + +
[docs] def get_random_transform(self, + min_scaling: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + max_scaling: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + transformation_dict: dict = None, + *args, **kwargs): + + + self._get_random_transform(min_scaling, max_scaling, + transform_dict=transformation_dict, + value_offset=1.0, + *args, **kwargs)
+ + # return self.t + + + + +
[docs]class RandomUniformScaling(ScalingTransform, RandomAffineTransform): + + # def __init__(self, + # dim: int, + # used_dimensions: bool = None, + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # + # *args, **kwargs): + # + # super(RandomUniformScaling, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + + +
[docs] def get_random_transform( + self, + min_scaling: Union[int, float, np.integer, np.floating, np.ndarray] = None, + max_scaling: Union[int, float, np.integer, np.floating, np.ndarray] = None, + transformation_dict: dict = None, + *args, **kwargs): + + + self._get_random_transform(min_scaling, max_scaling, + transform_dict=transformation_dict, + value_offset=1.0, + uniform=True, + *args, **kwargs)
+ + # return self.t + + + + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/spatial_transform.html b/_modules/medipt/transforms/spatial/spatial_transform.html new file mode 100644 index 0000000..2a4f66c --- /dev/null +++ b/_modules/medipt/transforms/spatial/spatial_transform.html @@ -0,0 +1,379 @@ + + + + + + medipt.transforms.spatial.spatial_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.spatial_transform

+from abc import ABC, abstractmethod
+import numpy as np
+import SimpleITK as sitk
+from typing import Union, Tuple, List
+from types import ModuleType
+from ...utils import image_index_to_phys
+from ...utils.random_float import initialize_rand_state
+from ...utils.image_input_output_space import resolve_input_output_space
+
+
[docs]class SpatialTransform(ABC): + """ + A generic spatial transform that can be applied to 2D and 3D images. + """ + def __init__(self, + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + *args, **kwargs): + """ + Initializer. + :param dim: The dimension of the transformation. + :param args: Arguments passed to super init. + :param kwargs: Keyword arguments passed to super init. + """ + + + self.used_dimensions = used_dimensions or [True] * dim + self.dim = dim + + self.seed = seed + self.legacy_random_state = legacy_random_state + + self.transform = None + + self.inverse_transform = None + + self.displacement_field = None + self.inverted_displacement_field = None + self.inverted_transform_from_displacement = None + + if rand_init is None: + self.rand_init = initialize_rand_state(self.seed, self.legacy_random_state) + else: + self.rand_init = rand_init + + assert len(self.used_dimensions) == dim, 'Length of used_dimensions must be equal to dim.' + + + self.input_size = None + self.input_space = None + self.input_origin = None + self.input_direction = None + + self.image_params_gathered = False + + + self.output_size = None + self.output_spacing = None + self.output_origin = None + self.output_direction = None + + + @abstractmethod + def _get_transform(self, + transform_params: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + + raise NotImplementedError('This method must be implemented in a child class.') + + + +
[docs] def get_inverse_transform(self, *args, **kwargs): + + + if self.transform is not None: + self.inverse_transform = self.transform.GetInverse() + + else: + raise ValueError('No transform found. Call get_transform first.')
+ + # return self.inverse_transform + +
[docs] def get_displacement_field(self, *args, **kwargs): + raise NotImplementedError('This method must be implemented in a child class.')
+ +
[docs] def get_inverted_displacement_field(self, *args, **kwargs): + raise NotImplementedError('This method must be implemented in a child class.')
+ +
[docs] def get_inverted_transform_from_displacement(self, *args, **kwargs): + self.get_inverse_transform(*args, **kwargs)
+ +
[docs] def get_image_params( + self, + image: sitk.Image = None, + image_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + image_direction: Union[List[Union[int, float]], Tuple[Union[int, float]]] = None, + *args, **kwargs) -> Tuple[ + Union[List[Union[int, float]], Tuple[Union[int, float]], np.ndarray], + Union[List[Union[int, float]], Tuple[Union[int, float]], np.ndarray], + Union[List[Union[int, float]], Tuple[Union[int, float]], np.ndarray], + Union[List[Union[int, float]], Tuple[Union[int, float]], np.ndarray]]: + + + if image is not None: + image_size = image.GetSize() + image_spacing = image.GetSpacing() + image_origin = image.GetOrigin() + image_direction = image.GetDirection() + + else: + image_size = kwargs.get('image_size', image_size) + image_spacing = kwargs.get('image_spacing', image_spacing) + image_origin = kwargs.get('image_origin', image_origin) + image_direction = kwargs.get('image_direction', image_direction) + + + + if image_spacing is None: + image_spacing = [1.0] * self.dim + + if image_origin is None: + image_origin = np.zeros(self.dim) + + if image_direction is None: + image_direction = np.eye(self.dim).flatten(order='F').tolist() + + + return image_size, image_spacing, image_origin, image_direction
+ +
[docs] def get_input_output_space(self, + # input_image: sitk.Image = None, + # input_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # output_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # input_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # + # + # output_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # input_direction: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # output_direction: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # input_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + # output_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + dict: dict = None, + *args, **kwargs): + + if dict is None: + dict = resolve_input_output_space(*args, **kwargs) + + elif len(dict) == 0: + dict = resolve_input_output_space(*args, **kwargs) + + + input_size = dict['input_size'] + input_spacing = dict['input_spacing'] + input_origin = dict['input_origin'] + input_direction = dict['input_direction'] + + output_size = dict['output_size'] + output_spacing = dict['output_spacing'] + output_origin = dict['output_origin'] + output_direction = dict['output_direction'] + + + self.input_size = input_size + self.input_spacing = input_spacing + self.input_origin = input_origin + self.input_direction = input_direction + + self.output_size = output_size + self.output_spacing = output_spacing + self.output_origin = output_origin + self.output_direction = output_direction + + self.image_params_gathered = True
+ + +
[docs] def get_input_origin(self, + *args, **kwargs) -> List[float]: + + if self.image_params_gathered is False: + self.get_input_output_space(*args, **kwargs) + + input_origin_index = (0.0,) * self.dim + + + input_origin_phys = image_index_to_phys(dim=self.dim, + index_coords=input_origin_index, + spacing=self.input_spacing, + direction=self.input_direction, + origin=self.input_origin) + + return input_origin_phys
+ +
[docs] def get_output_origin(self, *args, **kwargs) -> List[float]: + + if self.image_params_gathered is False: + self.get_input_output_space(*args, **kwargs) + + output_origin_index = (0.0,) * self.dim + + output_origin_phys = image_index_to_phys(dim=self.dim, + index_coords=output_origin_index, + spacing=self.output_spacing, + direction=self.output_direction, + origin=self.output_origin) + + return output_origin_phys
+ +
[docs] def get_input_center(self, *args, **kwargs) -> List[float]: + if self.image_params_gathered is False: + self.get_input_output_space(*args, **kwargs) + + + input_center_index = tuple([(i - 1) / 2 for i in self.input_size]) + + input_center_phys = image_index_to_phys(dim=self.dim, + index_coords=input_center_index, + spacing=self.input_spacing, + direction=self.input_direction, + origin=self.input_origin) + + return input_center_phys
+ + +
[docs] def get_random_point(self, + *args, **kwargs) -> List[float]: + + if self.image_params_gathered is False: + self.get_input_output_space(*args, **kwargs) + + input_center_index = tuple([(i - 1) / 2 for i in self.input_size]) + + input_center_index_min = np.array(input_center_index) - (np.array(input_center_index) // 4) + input_center_index_max = np.array(input_center_index) + (np.array(input_center_index) // 4) + + input_index = self.rand_init.randint(low=input_center_index_min, high=input_center_index_max) + + input_index = (int(input_index[0]), int(input_index[1]), int(input_index[2])) + + input_center_phys = image_index_to_phys(dim=self.dim, + index_coords=input_index, + spacing=self.input_spacing, + direction=self.input_direction, + origin=self.input_origin) + + return input_center_phys
+ + + +
[docs] def get_output_center(self, *args, **kwargs) -> List[float]: + if self.image_params_gathered is False: + self.get_input_output_space(*args, **kwargs) + + output_center_index = tuple([(i - 1) / 2 for i in self.output_size]) + + output_center_phys = image_index_to_phys(dim=self.dim, + index_coords=output_center_index, + spacing=self.output_spacing, + direction=self.output_direction, + origin=self.output_origin) + + return output_center_phys
+ + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/spatial_transform_init.html b/_modules/medipt/transforms/spatial/spatial_transform_init.html new file mode 100644 index 0000000..b5e6ec9 --- /dev/null +++ b/_modules/medipt/transforms/spatial/spatial_transform_init.html @@ -0,0 +1,429 @@ + + + + + + medipt.transforms.spatial.spatial_transform_init — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.spatial_transform_init

+from abc import ABC, abstractmethod
+import numpy as np
+import SimpleITK as sitk
+from typing import Union, Tuple, List
+from types import ModuleType
+from ...utils.random_float import initialize_rand_state
+
+from .composite_transform import CompositeTransform
+from .rotation_transform import RotationTransform, RandomRotation
+from .scaling_transform import ScalingTransform, RandomScaling, RandomUniformScaling
+from .flipping_transform import FlippingTransform, RandomFlipping
+
+from .elastic_deformation_transform import (
+    ElasticDeformation,
+    RandomElasticDeformation,
+    ElasticDeformationInputImage,
+    RandomElasticDeformationTransformInputImage,
+    RandomElasticDeformationTransformOutputImage)
+
+from .translation_transform import (
+    TranslationTransform,
+    RandomTranslation,
+    RandomCoordTranslation,
+    RandomBBoxTranslation,
+    TranslateInputCenterToOutputCenter,
+    TranslateInputOriginToOutputCenter,
+    TranslateInputCenterToInputOrigin,
+    TranslateRandomInputCenterToInputOrigin)
+
+    # TranslateInputOriginToInputCenter, TranslateInputOriginToOutputOrigin, \
+    # TranslateInputCenterToOutputOrigin, \
+
+
+
+
+
[docs]class SpatialTransformInit: + def __init__(self, + dim: int = 3, + used_dimensions: bool = None, + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None, + *args, **kwargs + ): + + self.used_dimensions = used_dimensions or [True] * dim + self.dim = dim + self.seed = seed + self.legacy_random_state = legacy_random_state + + if rand_init is None: + self.rand_init = initialize_rand_state(self.seed, self.legacy_random_state) + else: + self.rand_init = rand_init + + # Rotation Transforms + +
[docs] def rotation_transform(self, + *args, **kwargs): + return RotationTransform( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_rotation_transform(self, + *args, **kwargs): + + return RandomRotation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + + # Scaling Transforms + +
[docs] def scaling_transform(self, + *args, **kwargs): + return ScalingTransform( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_scaling_transform(self, + *args, **kwargs): + return RandomScaling( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_uniform_scaling_transform(self, + *args, **kwargs): + return RandomUniformScaling( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + + # Flipping Transforms + +
[docs] def flipping_transform(self, + *args, **kwargs): + return FlippingTransform( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_flipping_transform(self, + *args, **kwargs): + return RandomFlipping( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + + + + + # Translation Transforms + +
[docs] def translation_transform(self, + *args, **kwargs): + return TranslationTransform( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_translation_transform(self, + *args, **kwargs): + return RandomTranslation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + +
[docs] def random_coord_translation(self, + *args, **kwargs): + return RandomCoordTranslation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + +
[docs] def random_bbox_translation(self, + *args, **kwargs): + return RandomBBoxTranslation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + +
[docs] def translate_input_center_to_input_origin(self, + *args, **kwargs): + return TranslateInputCenterToInputOrigin( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + +
[docs] def translate_random_input_center_to_input_origin(self, + *args, **kwargs): + return TranslateRandomInputCenterToInputOrigin( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + +
[docs] def translate_input_origin_to_output_center(self, + *args, **kwargs): + return TranslateInputOriginToOutputCenter( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + + +
[docs] def translate_input_center_to_output_center(self, + *args, **kwargs): + return TranslateInputCenterToOutputCenter( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ + + # def translate_input_origin_to_input_center(self, + # *args, **kwargs): + # return TranslateInputOriginToInputCenter( + # dim=self.dim, + # used_dimensions=self.used_dimensions, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # *args, **kwargs) + # + # def translate_input_origin_to_output_origin(self, + # *args, **kwargs): + # return TranslateInputOriginToOutputOrigin( + # dim=self.dim, + # used_dimensions=self.used_dimensions, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # *args, **kwargs) + # + # def translate_input_center_to_output_origin(self, + # *args, **kwargs): + # return TranslateInputCenterToOutputOrigin( + # dim=self.dim, + # used_dimensions=self.used_dimensions, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # *args, **kwargs) + # + # + # def transate_input_origin_to_output_center(self, + # *args, **kwargs): + # return TranslateInputOriginToOutputCenter( + # dim=self.dim, + # used_dimensions=self.used_dimensions, + # seed=self.seed, + # legacy_random_state=self.legacy_random_state, + # *args, **kwargs) + + + + # Elastic Deformation Transforms + +
[docs] def elastic_deformation_transform(self, + *args, **kwargs): + return ElasticDeformation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_elastic_deformation_transform(self, + *args, **kwargs): + return RandomElasticDeformation( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def elastic_deformation_input_image(self, + *args, **kwargs): + return ElasticDeformationInputImage( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_elastic_deformation_input_image(self, + *args, **kwargs): + return RandomElasticDeformationTransformInputImage( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+ +
[docs] def random_elastic_deformation_output_image(self, + *args, **kwargs): + return RandomElasticDeformationTransformOutputImage( + dim=self.dim, + used_dimensions=self.used_dimensions, + seed=self.seed, + legacy_random_state=self.legacy_random_state, + rand_init=self.rand_init, + *args, **kwargs)
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/spatial/translation_transform.html b/_modules/medipt/transforms/spatial/translation_transform.html new file mode 100644 index 0000000..0445ea1 --- /dev/null +++ b/_modules/medipt/transforms/spatial/translation_transform.html @@ -0,0 +1,615 @@ + + + + + + medipt.transforms.spatial.translation_transform — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.spatial.translation_transform

+from typing import Union, Tuple, List
+from ...utils import random_uniform_float
+from ...utils import physical_image_size_no_origin, physical_image_size
+import SimpleITK as sitk
+import numpy as np
+
+from .spatial_transform import SpatialTransform
+from .random_affine_transform import RandomAffineTransform
+
+
+
+
+
[docs]class TranslationTransform(SpatialTransform): + """ + Translation transformation base class. + """ + # def __init__(self, + # dim: int = 3, + # used_dimensions: bool = None, + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # *args, **kwargs): + # """ + # Initializer + # :param dim: The dimension. + # :param used_dimensions: Boolean list of which dimension indizes to use for the transformation. + # :param args: Arguments passed to super init. + # :param kwargs: Keyword arguments passed to super init. + # """ + # + # super(TranslationTransform, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + # + # assert len(self.used_dimensions) == dim, 'Length of used_dimensions must be equal to dim.' + + def _get_transform(self, + translation: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + """ + Returns the sitk transform based on the given parameters. + :param dim: The dimension. + :param offset: List of offsets for each dimension. + :return: The sitk.AffineTransform(). + """ + + assert len(translation) == self.dim, 'Length of offset must be equal to dim.' + + t = sitk.AffineTransform(self.dim) + t.Translate(translation) + + self.transform = t + # return t + +
[docs] def get_transform(self, + translation: Union[List[float], Tuple[float, ...], float], + *args, **kwargs): + + self._get_transform(translation, *args, **kwargs)
+ + +
[docs]class RandomTranslation(RandomAffineTransform, TranslationTransform): + """ + A translation transformation with a random offset. + """ + # def __init__(self, + # # min_trans: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + # # max_trans: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + # dim: Union[int, None] = 3, + # used_dimensions: bool = None, + # + # seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + # legacy_random_state: bool = True, + # *args, **kwargs): + # """ + # Initializer. + # :param dim: The dimension. + # :param random_offset: List of random offsets per dimension. Random offset is calculated uniformly within [-random_offset[i], random_offset[i]] + # :param args: Arguments passed to super init. + # :param kwargs: Keyword arguments passed to super init. + # """ + # + # super(RandomTranslation, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + +
[docs] def get_random_transform(self, + min_trans: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + max_trans: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + transformation_dict=None, + *args, **kwargs): + + + self._get_random_transform(min_trans, max_trans, *args, **kwargs)
+ # return self.transform + + +
[docs]class RandomCoordTranslation(RandomAffineTransform, TranslationTransform): + def __init__(self, + dim: Union[int, None] = 3, + used_dimensions: bool = None, + + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, + *args, **kwargs): + """ + Initializer. + :param dim: The dimension. + :param random_offset: List of random offsets per dimension. Random offset is calculated uniformly within [-random_offset[i], random_offset[i]] + :param args: Arguments passed to super init. + :param kwargs: Keyword arguments passed to super init. + """ + + super(RandomCoordTranslation, self).__init__(dim, used_dimensions, seed, legacy_random_state, *args, **kwargs) + + +
[docs] def get_random_transform(self, + coord: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + translation_extent: Union[Union[List[Union[int, float]], Tuple[Union[int, float], ...]], int, float, np.integer, np.floating, np.ndarray], + transformation_dict: dict = None, + *args, **kwargs): + + + + if isinstance(translation_extent, (int, float, np.floating, np.integer)): + translation_extent = np.ndarray([translation_extent] * self.dim) + elif isinstance(translation_extent, (tuple, list)): + translation_extent = np.array(translation_extent) + elif isinstance(translation_extent, np.ndarray): + if len(translation_extent) < self.dim: + translation_extent = np.array([translation_extent] * self.dim) + + + if isinstance(coord, (int, float, np.floating, np.integer)): + coord = np.ndarray([coord] * self.dim) + elif isinstance(coord, (tuple, list)): + coord = np.array(coord) + + assert len(coord) == len(translation_extent), "coord and translation_extent must have the same length." + + + coord_min = coord - translation_extent + coord_max = coord + translation_extent + + self._get_random_transform(min_range=coord_min, max_range=coord_max, transformation_dict=transformation_dict, + offset=coord, *args, **kwargs)
+ + +
[docs]class TranslateInputCenterToInputOrigin(TranslationTransform): +
[docs] def get_transform(self, + *args, **kwargs): + + input_center_phys = self.get_input_center(*args, **kwargs) + input_origin_phys = self.get_input_origin(*args, **kwargs) + + # translation = tuple([input_center_phys[i] - input_origin_phys[i] for i in range(self.dim)]) + translation = tuple([input_center_phys[i] for i in range(self.dim)]) + + self._get_transform(translation)
+ + # return self.t + + + +
[docs]class TranslateRandomInputCenterToInputOrigin(TranslationTransform): +
[docs] def get_transform(self, + *args, **kwargs): + + input_center_phys = self.get_random_point(*args, **kwargs) + input_origin_phys = self.get_input_origin(*args, **kwargs) + + # translation = tuple([input_center_phys[i] - input_origin_phys[i] for i in range(self.dim)]) + translation = tuple([input_center_phys[i] for i in range(self.dim)]) + + self._get_transform(translation)
+ + # return self.t + + + +
[docs]class TranslateInputOriginToOutputCenter(TranslationTransform): +
[docs] def get_transform(self, + *args, **kwargs): + + input_origin_phys = self.get_input_origin(*args, **kwargs) + output_center_phys = self.get_output_center(*args, **kwargs) + + # translation = tuple([input_origin_phys[i] - output_center_phys[i] for i in range(self.dim)]) + translation = tuple([-output_center_phys[i] for i in range(self.dim)]) + + self._get_transform(translation)
+ + +class TranslateInputCenterToOutputCenter(TranslationTransform): + def get_transform(self, + *args, **kwargs): + + input_center_phys = self.get_input_center(*args, **kwargs) + output_center_phys = self.get_output_center(*args, **kwargs) + + + translation = tuple([input_center_phys[i] - output_center_phys[i] for i in range(self.dim)]) + + self._get_transform(translation) + + # return self.t + + +
[docs]class TranslateInputCenterToOutputCenter(TranslationTransform): +
[docs] def get_transform(self, + *args, **kwargs): + + input_center_phys = self.get_input_center(*args, **kwargs) + output_center_phys = self.get_output_center(*args, **kwargs) + + + translation = tuple([input_center_phys[i] - output_center_phys[i] for i in range(self.dim)]) + + self._get_transform(translation)
+ + # return self.t + + + +# +# class TranslateInputOriginToInputCenter(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_origin_phys = self.get_input_origin(*args, **kwargs) +# input_center_phys = self.get_input_center(*args, **kwargs) +# +# translation = tuple([input_origin_phys[i] - input_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# +# +# class TranslateInputOriginToOutputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_origin_phys = self.get_input_origin(*args, **kwargs) +# output_origin_phys = self.get_output_origin(*args, **kwargs) +# +# +# translation = tuple([input_origin_phys[i] - output_origin_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# +# +# +# +# +# +# class TranslateInputCenterToOutputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_center_phys = self.get_input_center(*args, **kwargs) +# output_origin_phys = self.get_input_origin(*args, **kwargs) +# +# +# translation = tuple([input_center_phys[i] - output_origin_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) + + + + + + + + + + + + + + + + + + + + + + +# class TranslateInputCenterToInputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_origin_phys = self.get_input_origin(*args, **kwargs) +# input_center_phys = self.get_input_center(*args, **kwargs) +# +# +# translation = tuple([input_center_phys[i] - input_origin_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# +# +# class TranslateInputOriginToOutputCenter(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# output_center_phys = self.get_output_center(*args, **kwargs) +# input_origin_phys = self.get_input_origin(*args, **kwargs) +# +# +# translation = tuple([input_origin_phys[i] - output_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# class TranslateOutputOriginToOutputCenter(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# output_center_phys = self.get_output_center(*args, **kwargs) +# output_origin_phys = self.get_output_origin(*args, **kwargs) +# +# translation = tuple([output_origin_phys[i] - output_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# class TranslateInputCenterToOutputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_center_phys = self.get_input_center(*args, **kwargs) +# # output_origin_phys = self.get_output_origin(*args, **kwargs) +# output_center_phys = self.get_output_center(*args, **kwargs) +# +# translation = tuple([-input_center_phys[i] + output_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# class TranslateInputOriginToOutputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_origin_phys = self.get_input_origin(*args, **kwargs) +# # output_origin_phys = self.get_output_origin(*args, **kwargs) +# output_center_phys = self.get_output_center(*args, **kwargs) +# +# translation = tuple([input_origin_phys[i] - output_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t +# +# +# +# class TranslateOutputCenterToOutputOrigin(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# output_center_phys = self.get_output_center(*args, **kwargs) +# output_origin_phys = self.get_output_origin(*args, **kwargs) +# +# translation = tuple([output_center_phys[i] - output_origin_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# class TranslateInputCenterToOutputCenter(TranslationTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_center_phys = self.get_input_center(*args, **kwargs) +# output_center_phys = self.get_output_center(*args, **kwargs) +# +# translation = tuple([input_center_phys[i] - output_center_phys[i] for i in range(self.dim)]) +# +# self._get_transform(translation) +# +# # return self.t + + + + +# class TranslateInputCenterToOutputCenter(TranslateTransform): +# def get_transform(self, +# *args, **kwargs): +# +# input_center_phys = self.get_input_center(*args, **kwargs) +# output_center_phys = self.get_output_center(*args, **kwargs) +# +# # additional = [70, 70, 0] +# additional = [0, 0, 0] +# translation = tuple([input_center_phys[i] - output_center_phys[i] + additional[i] for i in range(self.dim)]) +# +# +# +# +# # translation = self.get_output_center(*args, **kwargs) self.get_input_origin(*args, **kwargs) +# # +# # translation = [-1 * t for t in translation] +# +# self._get_transform(translation) + + +
[docs]class RandomBBoxTranslation(RandomAffineTransform, TranslationTransform): +
[docs] def get_random_transform(self, + transformation_dict: dict = None, + *args, **kwargs): + + bbox_center_start = kwargs.get('centroids_bb_start', None) + bbox_center_end = kwargs.get('centroids_bb_end', None) + + + + if (bbox_center_start is None) and (bbox_center_end is None): + raise ValueError('Centroid bounding box start and end must be provided when using ' + '"RandomBBoxTranslation".') + + bbox_extent = bbox_center_end - bbox_center_start + + output_size = kwargs.get('output_size', None) + output_spacing = kwargs.get('output_spacing', None) + output_direction = kwargs.get('output_direction', None) + dim = kwargs.get('dim', None) + + output_image_size_phys = physical_image_size_no_origin(dim=dim, + size=output_size, + spacing=output_spacing, + direction=output_direction) + + try: + extra_space = bbox_extent - np.array(output_image_size_phys) + except: + a = 1 + + # Only translate if the bbox is larger than the output image size + extra_space[extra_space < 0] = 0 + + max_trans = extra_space / 2 + min_trans = extra_space / 2 * -1 + + + self._get_random_transform(min_trans, max_trans, transformation_dict=transformation_dict, + *args, **kwargs)
+ + + + + + + + + + + +
[docs]class RandomFactorInput(TranslationTransform): + """ + A translation transform that translates the input image by a random factor, such that it will be cropped. + The input center should usually be at the origin before this transformation. + The actual translation value per dimension will be calculated as follows: + (input_size[i] * input_spacing[i] - self.remove_border[i]) * float_uniform(-self.random_factor[i], self.random_factor[i]) for each dimension. + """ +
[docs] def get_transform(self, + random_factor, + remove_border=None, + *args, **kwargs): + """ + Returns the sitk transform based on the given parameters. + :param kwargs: Must contain either 'image', or 'input_size' and 'input_spacing', which define the input image physical space. + :return: The sitk.AffineTransform(). + """ + + # TODO check to see if this works for arbitrary input directions and origins + + + remove_border = remove_border or [0.0] * self.dim + + self.get_input_output_space(*args, **kwargs) + + # assert np.allclose(self.input_direction, np.eye(self.dim).flatten()), 'this transformation only works for eye direction, is: ' + self.input_direction + # assert np.allclose(self.input_origin, np.zeros(self.dim)), 'this transformation only works for zeros origin, is: ' + self.input_origin + + + phys_input_size = physical_image_size_no_origin(dim=self.dim, + size=self.input_size, + spacing=self.input_spacing, + direction=self.input_direction) + + phys_input_size = np.array(phys_input_size) - np.array(remove_border) + + random_factor = np.array(random_factor) + + random_scaling = np.array(random_uniform_float(low_value=-random_factor, high_value=random_factor, + output_size=self.dim, + seed=self.seed, legacy_random_state=self.legacy_random_state)) + + translation = list(phys_input_size * random_scaling) + + self.transform = self._get_transform(translation)
+ +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/transforms/transform_coordinate.html b/_modules/medipt/transforms/transform_coordinate.html new file mode 100644 index 0000000..1aebe63 --- /dev/null +++ b/_modules/medipt/transforms/transform_coordinate.html @@ -0,0 +1,131 @@ + + + + + + medipt.transforms.transform_coordinate — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + + +
  • +
  • +
+
+
+
+
+ +

Source code for medipt.transforms.transform_coordinate

+from typing import Union, Tuple, List
+import SimpleITK as sitk
+import numpy as np
+
+
[docs]class TransformCoordinate: + + def __init__(self, + *args, **kwargs): + + pass + + +
[docs] def transform_coordinate(self, + phys_coordinate: Union[List[Union[float, int]], Tuple[Union[float, int], ...], float], + transform: sitk.Transform, + *args, **kwargs) -> Union[List[Union[float, int]], Tuple[Union[float, int], ...], float]: + + transform_coord = transform.TransformPoint(phys_coordinate) + + return transform_coord
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/utils.html b/_modules/medipt/utils.html new file mode 100644 index 0000000..78dfbf4 --- /dev/null +++ b/_modules/medipt/utils.html @@ -0,0 +1,118 @@ + + + + + + medipt.utils — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for medipt.utils

+from .random_float import random_uniform_float, random_binomial
+from .spatial_utils import *
+import SimpleITK as sitk
+
+
+
[docs]def set_num_workers(n_threads): + sitk.ProcessObject.SetGlobalDefaultNumberOfThreads(n_threads)
+
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/utils/image_input_output_space.html b/_modules/medipt/utils/image_input_output_space.html new file mode 100644 index 0000000..1cee151 --- /dev/null +++ b/_modules/medipt/utils/image_input_output_space.html @@ -0,0 +1,236 @@ + + + + + + medipt.utils.image_input_output_space — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for medipt.utils.image_input_output_space

+import SimpleITK as sitk
+import numpy as np
+from typing import Union, Tuple, List
+
+from .spatial_utils import get_output_size_from_spacing, get_output_spacing_from_size
+
+
+
+
[docs]def resolve_input_output_space( + dim: int = 3, + input_image: sitk.Image = None, + reference_image: sitk.Image = None, + input_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + output_size: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + input_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + + output_spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + input_direction: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + output_direction: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + input_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + output_origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + *args, **kwargs): + + + if input_image is not None: + input_size = input_image.GetSize() + input_spacing = input_image.GetSpacing() + input_origin = input_image.GetOrigin() + input_direction = input_image.GetDirection() + + else: + input_size = kwargs.get('input_size', input_size) + input_spacing = kwargs.get('input_spacing', input_spacing) + input_origin = kwargs.get('input_origin', input_origin) + input_direction = kwargs.get('input_direction', input_direction) + + if input_spacing is None: + input_spacing = [1.0] * dim + + if input_origin is None: + input_origin = [0] * dim + + if input_direction is None: + input_direction = np.eye(dim).flatten().tolist() + + if reference_image is not None: + output_size = reference_image.GetSize() + output_direction = reference_image.GetDirection() + output_origin = reference_image.GetOrigin() + output_spacing = reference_image.GetSpacing() + else: + output_size = kwargs.get('output_size', output_size) + output_spacing = kwargs.get('output_spacing', output_spacing) + output_origin = kwargs.get('output_origin', output_origin) + output_direction = kwargs.get('output_direction', output_direction) + + + if (output_size is None) and (output_spacing is None) and (input_image is None): + raise ValueError('One of output_size, output_spacing or input_image must be provided.') + + if output_direction is None: + output_direction = input_direction + + if output_origin is None: + output_origin = input_origin + + if (output_size is None) and (output_spacing is not None): + output_size = get_output_size_from_spacing(dim=dim, + input_size=input_size, + input_spacing=input_spacing, + input_direction=input_direction, + output_spacing=output_spacing, + output_direction=output_direction, + *args, **kwargs) + + output_size = [int(np.round(x)) for x in output_size] + + elif (output_size is not None) and (output_spacing is None): + output_spacing = get_output_spacing_from_size(dim=dim, + input_size=input_size, + input_spacing=input_spacing, + input_direction=input_direction, + output_size=output_size, + output_direction=output_direction, + *args, **kwargs) + + + + elif (output_spacing is None) and (output_size is None): + output_spacing = input_spacing + output_size = input_size + + kwargs['input_image'] = input_image + kwargs['input_size'] = input_size + kwargs['input_spacing'] = input_spacing + kwargs['input_origin'] = input_origin + kwargs['input_direction'] = input_direction + + kwargs['output_size'] = output_size + kwargs['output_spacing'] = output_spacing + kwargs['output_origin'] = output_origin + kwargs['output_direction'] = output_direction + + return kwargs
+ + + +if __name__ == '__main__': + + + dim = 3 + + input_image = sitk.ReadImage('../../testing_files/sub-verse260.nii.gz') + + output_size = [256, 256, 256] + output_spacing = [3.0, 5.0, 2.0] + + hold = resolve_input_output_space(dim=dim, + input_image=input_image, + output_size=output_size, + # output_spacing=output_spacing, ) + ) + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/utils/random_float.html b/_modules/medipt/utils/random_float.html new file mode 100644 index 0000000..e6ae7ae --- /dev/null +++ b/_modules/medipt/utils/random_float.html @@ -0,0 +1,406 @@ + + + + + + medipt.utils.random_float — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for medipt.utils.random_float

+import numpy as np
+import random
+from typing import Union, Tuple, List, Any, Callable, Optional
+from types import ModuleType
+
+
+
[docs]def initialize_rand_state( + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + legacy_random_state: bool = True, ) -> Union[ModuleType, np.random.Generator, np.random.BitGenerator]: + if seed is not None: + if isinstance(seed, int): + if legacy_random_state: + np.random.seed(seed) + random.seed(seed) + + else: + ran_gen = np.random.default_rng(seed) + random.seed(seed) + + elif isinstance(seed, np.random.RandomState): + np.random.set_state(np.random.get_state()) + random.setstate(random.getstate()) + + elif isinstance(seed, (np.random.Generator, np.random.BitGenerator)): + ran_gen = np.random.default_rng(seed) + + else: + if legacy_random_state: + np.random.set_state(np.random.get_state()) + random.setstate(random.getstate()) + + else: + ran_gen = np.random.default_rng() + + if legacy_random_state: + rand_init = np.random + + else: + rand_init = ran_gen + + return rand_init
+ + +
[docs]def random_binomial( + n: Union[int, float, np.integer, np.floating], + p: Union[int, float, np.integer, np.floating], + output_size: Union[List[Union[int, float]], Tuple[Union[int, float]], int, float, np.integer, np.floating] = None, + + ignore_axis: Union[None, List[int], Tuple[int], int] = None, + + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + + legacy_random_state: bool = True, + + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None) -> Union[np.ndarray, int]: + ''' + + :param n: + :param p: + :param output_size: + :param ignore_axis: Ignores the axis specified. If None, then no axis is ignored. Works only for 1D right now. + :param seed: + :param legacy_random_state: + :return: + ''' + + if rand_init is None: + rand_init = initialize_rand_state(seed=seed, legacy_random_state=legacy_random_state) + + binomial_out = rand_init.binomial(n=n, p=p, size=output_size) + + if (output_size is not None) and (ignore_axis is not None): + if isinstance(ignore_axis, int): + binomial_out[ignore_axis] = 1 + + elif isinstance(ignore_axis, (list, tuple)): + for idx in ignore_axis: + binomial_out[idx] = 1 + + else: + raise ValueError('ignore_axis must be an int, list, or tuple.') + + return binomial_out
+ + +
[docs]def random_uniform_float( + low_value: Union[float, int, List[Union[int, float]], Tuple[Union[int, float], ...], np.integer, np.floating, np.ndarray], + high_value: Union[float, int, List[Union[int, float]], Tuple[Union[int, float], ...], np.integer, np.floating, np.ndarray], + output_size: Union[float, int, List[Union[int, float]], Tuple[Union[int, float], ...], np.integer, np.floating, np.ndarray, None] = None, + + dim: Union[int, None] = None, + + seed: Union[np.random.RandomState, np.random.Generator, np.random.BitGenerator, int, None] = None, + + legacy_random_state: bool = True, + + rand_init: Union[ModuleType, np.random.Generator, np.random.BitGenerator] = None + + +) -> Union[float, List[float], np.ndarray]: + + if rand_init is None: + rand_init = initialize_rand_state(seed=seed, legacy_random_state=legacy_random_state) + + # if seed is not None: + # if isinstance(seed, int): + # if legacy_random_state: + # np.random.seed(seed) + # random.seed(seed) + # + # else: + # ran_gen = np.random.default_rng(seed) + # random.seed(seed) + # + # elif isinstance(seed, np.random.RandomState): + # np.random.set_state(np.random.get_state()) + # random.setstate(random.getstate()) + # + # elif isinstance(seed, (np.random.Generator, np.random.BitGenerator)): + # ran_gen = np.random.default_rng(seed) + # + # else: + # if legacy_random_state: + # np.random.set_state(np.random.get_state()) + # random.setstate(random.getstate()) + # + # else: + # ran_gen = np.random.default_rng() + # + # + # if legacy_random_state: + # rand_init = np.random + # + # else: + # rand_init = ran_gen + + if (output_size is not None) and (dim is not None): + if isinstance(output_size, (int, float, np.integer, np.floating)): + + output_size = (output_size, dim) + + elif isinstance(output_size, (list, tuple, np.ndarray)): + output_size = *output_size, dim + + else: + raise ValueError('output_size must be a number, list, tuple, or numpy array.') + + if isinstance(low_value, np.ndarray) or (isinstance(high_value, np.ndarray)): + if isinstance(low_value, np.ndarray) and (isinstance(high_value, np.ndarray)): + if low_value.shape != high_value.shape: + raise ValueError('shape of low_value must be equal to shape of high_value.') + + else: + if output_size is None: + random_uniform = [float(rand_init.uniform(low=l, high=h)) for l, h in zip(low_value, high_value)] + return random_uniform + + else: + random_uniform = rand_init.uniform(low=low_value, high=high_value, size=output_size) + return random_uniform + + + elif isinstance(low_value, np.ndarray) and (isinstance(high_value, (int, float, np.integer, np.floating))): + if len(low_value) > 1: + raise ValueError('size of low_value must be equal to size of high_value.') + + else: + low_value = low_value[0] + random_uniform = float(rand_init.uniform(low=low_value, high=high_value)) + return random_uniform + + elif isinstance(low_value, (int, float, np.integer, np.floating)) and (isinstance(high_value, np.ndarray)): + if len(high_value) > 1: + raise ValueError('size of low_value must be equal to size of high_value.') + else: + high_value = high_value[0] + random_uniform = float(rand_init.uniform(low=low_value, high=high_value)) + return random_uniform + + # if output_size is None: + # random_uniform = np.random.uniform(low=low_value, high=high_value) + # return random_uniform + # + # else: + # random_uniform = np.random.uniform(low=low_value, hig + + elif (isinstance(low_value, (int, float, np.integer, np.floating)) is False) and ( + isinstance(high_value, (int, float, np.integer, np.floating)) is False): + if len(low_value) != len(high_value): + raise ValueError('size of low_value must be equal to size of high_value.') + + elif (isinstance(low_value, (int, float, np.integer, np.floating)) is False) and ( + isinstance(high_value, (int, float, np.integer, np.floating))): + high_value = [high_value] * len(low_value) + + elif (isinstance(low_value, (int, float, np.integer, np.floating))) and ( + isinstance(high_value, (int, float, np.integer, np.floating)) is False): + low_value = [low_value] * len(high_value) + + + + + + else: + random_uniform = rand_init.uniform(low=low_value, high=high_value, size=output_size) + return random_uniform + + if output_size is None: + random_uniform = [float(rand_init.uniform(low=l, high=h)) for l, h in zip(low_value, high_value)] + return random_uniform + + else: + random_uniform = np.stack( + [rand_init.uniform(low=l, high=h, size=output_size) for l, h in zip(low_value, high_value)]) + + return random_uniform
+ + # random_val_list = None + # output_size_no_channel = None + # if output_size: + # if len(output_size) > dim: + # output_size_no_channel = output_size[:dim] + # + # if isinstance(value, (int, float)): + # if output_size is not None: + # random_val_list = np.random.uniform(low=-value, high=value, size=output_size) + # else: + # random_val_list = list(np.random.uniform(low=-value, high=value, size=dim)) + # + # elif isinstance(value, (tuple, list)): + # if isinstance(value[0], (float, int)): + # if len(value) == 1: + # if output_size is None: + # random_val_list = list(np.random.uniform(low=-value[0], high=value[0], size=dim)) + # + # else: + # random_val_list = np.zeros(tuple(output_size)) + # random_val_list[..., 0] = np.random.uniform(low=-value[0], high=value[0], + # size=output_size_no_channel) + # elif len(value) == dim: + # if output_size is None: + # random_val_list = [np.random.uniform(low=-val, high=val) for val in value] + # + # else: + # random_val_list = np.zeros(tuple(output_size)) + # for val_idx, val in enumerate(value): + # random_val_list[..., val_idx] = np.random.uniform(low=-val, high=val, + # size=output_size_no_channel) + # + # + # elif len(value) == 2: + # if output_size is not None: + # random_val_list = np.random.uniform(low=value[0], high=value[1], size=output_size) + # else: + # random_val_list = list(np.random.uniform(low=value[0], high=value[1], size=dim)) + # + # elif len(value) == dim * 2: + # val_reshape = [] + # counter = 0 + # for v in value: + # if counter == 0: + # v_hold = [] + # v_hold.append(v) + # counter = 1 + # elif counter == 1: + # v_hold.append(v) + # val_reshape.append(v_hold) + # counter = 0 + # + # if output_size is None: + # random_val_list = [np.random.uniform(low=val[0], high=val[1]) for val in val_reshape] + # + # else: + # random_val_list = np.zeros(tuple(output_size)) + # for val_idx, value in enumerate(value): + # random_val_list[..., val_idx] = np.random.uniform(low=value[val_idx][0], high=value[val_idx][1], + # size=output_size_no_channel) + # + # elif isinstance(value[0], (tuple, list)): + # random_val_list = [np.random.uniform(low=val[0], high=val[1]) for val in value] + # + # elif isinstance(value[0], np.ndarray): + # raise ValueError('Numpy arrays are not currently supported. Please use list or tuples.') + # else: + # raise ValueError('value was found to have an incorrect shape') + # + # + # elif isinstance(value, np.ndarray): + # raise ValueError('Numpy arrays are not currently supported. Please use list, tuples, floats or ints') + # else: + # raise ValueError('value was found to have an incorrect shape') + # + # + # return random_val_list +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_modules/medipt/utils/spatial_utils.html b/_modules/medipt/utils/spatial_utils.html new file mode 100644 index 0000000..82f50d2 --- /dev/null +++ b/_modules/medipt/utils/spatial_utils.html @@ -0,0 +1,229 @@ + + + + + + medipt.utils.spatial_utils — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for medipt.utils.spatial_utils

+import SimpleITK as sitk
+import numpy as np
+from typing import Union, Tuple, List
+
+
+
[docs]def image_center(input_size: Tuple[int, ...], + *args, **kwargs): + + # -1 is important, as it is always the center pixel. + input_size_half = [(size - 1) * 0.5 for size in input_size] + return input_size_half
+ + +
[docs]def physical_image_size(dim: int, + size: Tuple[int, ...], + spacing: Tuple[float, ...], + direction: Tuple[float, ...], + origin: Tuple[float, ...], + *args, **kwargs) -> List[float]: + + phys_size = np.array(origin) + np.matmul(size, np.matmul(np.array(direction).reshape([dim, dim]), np.diag(spacing))) + + return list(phys_size)
+ + +
[docs]def physical_image_size_no_origin(dim: int, + size: Tuple[int, ...], + spacing: Tuple[float, ...], + direction: Tuple[float, ...], + *args, **kwargs) -> List[float]: + + phys_size = np.matmul(size, np.matmul(np.array(direction).reshape([dim, dim]), np.diag(spacing))) + + return list(phys_size)
+ + + +
[docs]def get_output_size_from_spacing(dim: int, + input_size: Union[List[int], Tuple[int, ...]], + input_spacing: Union[List[int], Tuple[int, ...]], + input_direction: Union[List[int], Tuple[int, ...]], + output_spacing: Union[List[int], Tuple[int, ...]], + output_direction: Union[List[int], Tuple[int, ...]] = None, + *args, **kwargs): + + input_total_space = physical_image_size_no_origin(dim=dim, + size=input_size, + spacing=input_spacing, + direction=input_direction) + + output_direction_reshape = np.array(output_direction).reshape([dim, dim]) + + + out_spacing_direction = np.matmul(output_direction_reshape, np.diag(output_spacing)) + + output_size = np.matmul(input_total_space, np.linalg.inv(out_spacing_direction)) + + return output_size
+ + +
[docs]def get_output_spacing_from_size(dim: int, + input_size: Union[List[int], Tuple[int, ...]], + input_spacing: Union[List[int], Tuple[int, ...]], + input_direction: Union[List[int], Tuple[int, ...]], + output_size: Union[List[int], Tuple[int, ...]], + output_direction: Union[List[int], Tuple[int, ...]] = None, + *args, **kwargs): + + input_total_space = physical_image_size_no_origin(dim=dim, + size=input_size, + spacing=input_spacing, + direction=input_direction) + + output_direction_reshape = np.array(output_direction).reshape([dim, dim]) + + + out_size_direction = np.matmul(np.diag(output_size), output_direction_reshape) + + output_spacing = np.matmul(np.linalg.inv(out_size_direction), input_total_space) + + return output_spacing
+ + +
[docs]def image_index_to_phys(dim: int, + index_coords: Union[List[Union[int, float]], Tuple[Union[int, float], ...]], + image: sitk.Image = None, + size: Tuple[int, ...] = None, + origin: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + spacing: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + direction: Union[List[Union[int, float]], Tuple[Union[int, float], ...]] = None, + *args, **kwargs) -> List[float]: + + + if image is not None: + phys_coord = image.TransformContinuousIndexToPhysicalPoint(index_coords) + return phys_coord + + + if spacing is None: + spacing = [1.0] * dim + + if origin is None: + origin = [0] * dim + + if direction is None: + direction = np.eye(dim).flatten().tolist() + + phys_coord = np.array(origin) + np.matmul( + np.matmul(np.array(direction).reshape([dim, dim]), np.diag(spacing)), + np.array(index_coords) + ) + + + return list(phys_coord)
+ + + +
+ +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_sources/documentation/medipt.crop_image.rst.txt b/_sources/documentation/medipt.crop_image.rst.txt new file mode 100644 index 0000000..ffedaa8 --- /dev/null +++ b/_sources/documentation/medipt.crop_image.rst.txt @@ -0,0 +1,21 @@ +medipt.crop\_image package +========================== + +Submodules +---------- + +medipt.crop\_image.threshold\_crop\_background module +----------------------------------------------------- + +.. automodule:: medipt.crop_image.threshold_crop_background + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.crop_image + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.resample_image.rst.txt b/_sources/documentation/medipt.resample_image.rst.txt new file mode 100644 index 0000000..5e8c625 --- /dev/null +++ b/_sources/documentation/medipt.resample_image.rst.txt @@ -0,0 +1,21 @@ +medipt.resample\_image package +============================== + +Submodules +---------- + +medipt.resample\_image.resample\_image module +--------------------------------------------- + +.. automodule:: medipt.resample_image.resample_image + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.resample_image + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.rst.txt b/_sources/documentation/medipt.rst.txt new file mode 100644 index 0000000..71e8d47 --- /dev/null +++ b/_sources/documentation/medipt.rst.txt @@ -0,0 +1,20 @@ +medipt package +============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + medipt.resample_image + medipt.transforms + medipt.utils + +Module contents +--------------- + +.. automodule:: medipt + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.transforms.intensity.rst.txt b/_sources/documentation/medipt.transforms.intensity.rst.txt new file mode 100644 index 0000000..6b04228 --- /dev/null +++ b/_sources/documentation/medipt.transforms.intensity.rst.txt @@ -0,0 +1,77 @@ +medipt.transforms.intensity package +=================================== + +Submodules +---------- + +medipt.transforms.intensity.change\_image\_gamma module +------------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.change_image_gamma + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.clamp\_intensity module +--------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.clamp_intensity + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.gaussian\_blur module +------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.gaussian_blur + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.gaussian\_noise module +-------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.gaussian_noise + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.intensity\_utils\_np module +------------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.intensity_utils_np + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.intensity\_utils\_sitk module +--------------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.intensity_utils_sitk + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.rescale\_intensity module +----------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.rescale_intensity + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.intensity.shift\_scale\_intensity module +---------------------------------------------------------- + +.. automodule:: medipt.transforms.intensity.shift_scale_intensity + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.transforms.intensity + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.transforms.rst.txt b/_sources/documentation/medipt.transforms.rst.txt new file mode 100644 index 0000000..b6553f4 --- /dev/null +++ b/_sources/documentation/medipt.transforms.rst.txt @@ -0,0 +1,30 @@ +medipt.transforms package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + medipt.transforms.intensity + medipt.transforms.spatial + +Submodules +---------- + +medipt.transforms.transform\_coordinate module +---------------------------------------------- + +.. automodule:: medipt.transforms.transform_coordinate + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.transforms + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.transforms.spatial.functional_legacy.rst.txt b/_sources/documentation/medipt.transforms.spatial.functional_legacy.rst.txt new file mode 100644 index 0000000..143154f --- /dev/null +++ b/_sources/documentation/medipt.transforms.spatial.functional_legacy.rst.txt @@ -0,0 +1,45 @@ +medipt.transforms.spatial.functional\_legacy package +==================================================== + +Submodules +---------- + +medipt.transforms.spatial.functional\_legacy.flipping module +------------------------------------------------------------ + +.. automodule:: medipt.transforms.spatial.functional_legacy.flipping + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.functional\_legacy.rotation module +------------------------------------------------------------ + +.. automodule:: medipt.transforms.spatial.functional_legacy.rotation + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.functional\_legacy.scaling module +----------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.functional_legacy.scaling + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.functional\_legacy.translation module +--------------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.functional_legacy.translation + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.transforms.spatial.functional_legacy + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.transforms.spatial.rst.txt b/_sources/documentation/medipt.transforms.spatial.rst.txt new file mode 100644 index 0000000..b35f366 --- /dev/null +++ b/_sources/documentation/medipt.transforms.spatial.rst.txt @@ -0,0 +1,93 @@ +medipt.transforms.spatial package +================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + medipt.transforms.spatial.functional_legacy + +Submodules +---------- + +medipt.transforms.spatial.composite\_transform module +----------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.composite_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.elastic\_deformation\_transform module +---------------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.elastic_deformation_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.flipping\_transform module +---------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.flipping_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.random\_affine\_transform module +---------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.random_affine_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.rotation\_transform module +---------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.rotation_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.scaling\_transform module +--------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.scaling_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.spatial\_transform module +--------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.spatial_transform + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.spatial\_transform\_init module +--------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.spatial_transform_init + :members: + :undoc-members: + :show-inheritance: + +medipt.transforms.spatial.translation\_transform module +------------------------------------------------------- + +.. automodule:: medipt.transforms.spatial.translation_transform + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.transforms.spatial + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/medipt.utils.rst.txt b/_sources/documentation/medipt.utils.rst.txt new file mode 100644 index 0000000..97aadf6 --- /dev/null +++ b/_sources/documentation/medipt.utils.rst.txt @@ -0,0 +1,37 @@ +medipt.utils package +==================== + +Submodules +---------- + +medipt.utils.image\_input\_output\_space module +----------------------------------------------- + +.. automodule:: medipt.utils.image_input_output_space + :members: + :undoc-members: + :show-inheritance: + +medipt.utils.random\_float module +--------------------------------- + +.. automodule:: medipt.utils.random_float + :members: + :undoc-members: + :show-inheritance: + +medipt.utils.spatial\_utils module +---------------------------------- + +.. automodule:: medipt.utils.spatial_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: medipt.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/_sources/documentation/modules.rst.txt b/_sources/documentation/modules.rst.txt new file mode 100644 index 0000000..5cefcba --- /dev/null +++ b/_sources/documentation/modules.rst.txt @@ -0,0 +1,7 @@ +medipt +====== + +.. toctree:: + :maxdepth: 4 + + medipt diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..f833da3 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,40 @@ +.. ImageProcessingTools documentation master file, created by + sphinx-quickstart on Thu Jul 20 11:57:56 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to ImageProcessingTools's documentation! +================================================ + +Documentation for the ImageProcessingTools package. + + +.. toctree:: + :maxdepth: 2 + :caption: Install Instructions: + + install/installation + +.. toctree:: + :maxdepth: 2 + :caption: Package References: + + documentation/medipt + + +.. toctree:: + :maxdepth: 2 + :caption: Examples: + + examples/example1 + examples/example2 + + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/_sources/install/installation.rst.txt b/_sources/install/installation.rst.txt new file mode 100644 index 0000000..ea1f9c5 --- /dev/null +++ b/_sources/install/installation.rst.txt @@ -0,0 +1,36 @@ +Installation +================== + +MedIPT is available for Python 3.7 to 3.11, and can be installed via pip or conda. + +Installation via Anaconda +------------------------- + +The easiest way to install **MedIPT** is with `Anaconda `_ and is available for all major OS platforms. + +If **SimpleITK** is already installed, **MedIPT** can be installed with the following command: +.. code-block:: + + conda install -c medipt medipt + +Otherwise, `MedIPT` can be installed with the following command: +.. code-block:: + + conda install -c medipt -c simpleitk -c medipt + + +On **Windows**, if **SimpleITK** is not installed, ensure **conda-forge** is being used to install. +.. code-block:: + + conda install -c medipt -c simpleitk -c conda-forge medipt + + + +Installation via pip +-------------------- + +Pip installation can be done by: +.. code-block:: + + pip install -i https://pypi.anaconda.org/medipt/simple medipt + diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..7577acb --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,903 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..b57ae3b --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/html5shiv.min.js b/_static/js/html5shiv.min.js new file mode 100644 index 0000000..cd1c674 --- /dev/null +++ b/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/theme.js b/_static/js/theme.js new file mode 100644 index 0000000..1fddb6e --- /dev/null +++ b/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..84ab303 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..97d56a7 --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,566 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = docUrlRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = docUrlRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..aae669d --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,144 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + parent.insertBefore( + span, + parent.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(SphinxHighlight.highlightSearchWords); +_ready(SphinxHighlight.initEscapeListener); diff --git a/documentation/medipt.crop_image.html b/documentation/medipt.crop_image.html new file mode 100644 index 0000000..2c070ae --- /dev/null +++ b/documentation/medipt.crop_image.html @@ -0,0 +1,140 @@ + + + + + + + medipt.crop_image package — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.crop_image package

+
+

Submodules

+
+
+

medipt.crop_image.threshold_crop_background module

+
+
+medipt.crop_image.threshold_crop_background.threshold_crop_background(image, inside_value, outside_value, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
    +
  • image (Image) –

  • +
  • inside_value (int | float) –

  • +
  • outside_value (int | float) –

  • +
+
+
+
+ +
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.html b/documentation/medipt.html new file mode 100644 index 0000000..3b373d3 --- /dev/null +++ b/documentation/medipt.html @@ -0,0 +1,224 @@ + + + + + + + medipt package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt package

+
+

Subpackages

+
+ +
+
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.resample_image.html b/documentation/medipt.resample_image.html new file mode 100644 index 0000000..ce1e898 --- /dev/null +++ b/documentation/medipt.resample_image.html @@ -0,0 +1,263 @@ + + + + + + + medipt.resample_image package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.resample_image package

+
+

Submodules

+
+
+

medipt.resample_image.resample_image module

+
+
+class medipt.resample_image.resample_image.ResampleImage(interpolator='linear', post_processing_sitk=None, pixel_type='float32', default_pixel_value=None, dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+
+get_images(images, input_output_space_dict, reference_image=None, transform=None, *args, **kwargs)[source]
+
+
Parameters:
+
    +
  • images (List[Image] | Tuple[Image, ...] | Image) –

  • +
  • input_output_space_dict (dict) –

  • +
  • reference_image (Image) –

  • +
  • transform (Transform) –

  • +
+
+
+
+ +
+
+get_resampled_images(image, input_output_space_dict, reference_image=None, transform=None, *args, **kwargs)[source]
+
+
Return type:
+

Union[List[Image], Tuple[Image, ...], Image]

+
+
Parameters:
+
    +
  • image (List[Image] | Tuple[Image, ...] | Image) –

  • +
  • input_output_space_dict (dict) –

  • +
  • reference_image (Image) –

  • +
  • transform (Transform) –

  • +
+
+
+
+ +
+
+resample_image(image, input_output_space_dict, reference_image=None, transform=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
    +
  • image (Image) –

  • +
  • input_output_space_dict (dict) –

  • +
  • reference_image (Image) –

  • +
  • transform (Transform) –

  • +
+
+
+
+ +
+ +
+
+medipt.resample_image.resample_image.get_simpleitk_pix_type(pixel_type)[source]
+

Returns the SimpleITK pixel type for the given pixel type string.

+
+
Parameters:
+

pixel_type (Union[str, int]) – The pixel type as string. +‘float32’: sitk.sitkFloat32 +‘float64’: sitk.sitkFloat64 +‘int8’: sitk.sitkInt8 +‘int16’: sitk.sitkInt16 +‘int32’: sitk.sitkInt32 +‘int64’: sitk.sitkInt64 +‘uint8’: sitk.sitkUInt8 +‘uint16’: sitk.sitkUInt16 +‘uint32’: sitk.sitkUInt32 +‘uint64’: sitk.sitkUInt64 +‘complex64’: sitk.sitkComplexFloat32 +‘complex128’: sitk.sitkComplexFloat64

+
+
Return type:
+

int

+
+
Returns:
+

The SimpleITK pixel type.

+
+
+
+ +
+
+medipt.resample_image.resample_image.get_sitk_interpolator(interpolator)[source]
+

Return an sitk interpolator object for the given string.

+
+
Parameters:
+

interpolator – Interpolator type as string. +‘nearest’: sitk.sitkNearestNeighbor +‘linear’: sitk.sitkLinear +‘cubic’: sitk.sitkBSpline +‘label_gaussian’: sitk.sitkLabelGaussian +‘gaussian’: sitk.sitkGaussian +‘lanczos’: sitk.sitkLanczosWindowedSinc

+
+
Returns:
+

The sitk interpolator object.

+
+
+
+ +
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.transforms.html b/documentation/medipt.transforms.html new file mode 100644 index 0000000..365a7c4 --- /dev/null +++ b/documentation/medipt.transforms.html @@ -0,0 +1,411 @@ + + + + + + + medipt.transforms package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.transforms package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

medipt.transforms.transform_coordinate module

+
+
+class medipt.transforms.transform_coordinate.TransformCoordinate(*args, **kwargs)[source]
+

Bases: object

+
+
+transform_coordinate(phys_coordinate, transform, *args, **kwargs)[source]
+
+
Return type:
+

Union[List[Union[int, float]], Tuple[Union[int, float], ...], float]

+
+
Parameters:
+
+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.transforms.intensity.html b/documentation/medipt.transforms.intensity.html new file mode 100644 index 0000000..00160cc --- /dev/null +++ b/documentation/medipt.transforms.intensity.html @@ -0,0 +1,564 @@ + + + + + + + medipt.transforms.intensity package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.transforms.intensity package

+
+

Submodules

+
+
+

medipt.transforms.intensity.change_image_gamma module

+
+
+medipt.transforms.intensity.change_image_gamma.change_gamma(img, l)[source]
+
+ +
+
+medipt.transforms.intensity.change_image_gamma.change_gamma_unnormalized(img, l)[source]
+
+ +
+
+medipt.transforms.intensity.change_image_gamma.random_change_gamma(img, lambda_min=0.5, lambda_max=1.5, seed=None, legacy_random_state=True)[source]
+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.change_image_gamma.scale(img, old_range, new_range)[source]
+
+ +
+
+

medipt.transforms.intensity.clamp_intensity module

+
+
+class medipt.transforms.intensity.clamp_intensity.ClampIntensity(window_min=None, window_max=None, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.gaussian_blur module

+
+
+class medipt.transforms.intensity.gaussian_blur.GaussianBlur(sigma, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+

sigma (int | float) –

+
+
+
+ +
+
+class medipt.transforms.intensity.gaussian_blur.RandomGaussianBlur(min_sigma, max_sigma, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.gaussian_noise module

+
+
+class medipt.transforms.intensity.gaussian_noise.GaussianNoise(mean, sigma, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+class medipt.transforms.intensity.gaussian_noise.RandomGaussianNoise(mean=None, min_mean=None, max_mean=None, sigma=None, min_sigma=None, max_sigma=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.intensity_utils_np module

+
+
+medipt.transforms.intensity.intensity_utils_np.change_image_gamma_np(image, gamma, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.clamp_intensity_np(image, window_min=None, window_max=None, image_min=None, image_max=None, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.gaussian_blur_np(image, sigma, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.gaussian_noise_np(image, mean, sigma, rand_init=None, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.rescale_intensity_np(image, output_min=None, output_max=None, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.rescale_intensity_window_np(image, input_min=None, input_max=None, output_min=None, output_max=None, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_np.shift_scale_intensity_np(image, shift=None, scale=None, *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.intensity_utils_sitk module

+
+
+medipt.transforms.intensity.intensity_utils_sitk.change_image_gamma_sitk(image, gamma, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
    +
  • image (Image) –

  • +
  • gamma (int | float) –

  • +
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.clamp_intensity_sitk(image, window_min=None, window_max=None, image_min=None, image_max=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.gaussian_blur_sitk(image, sigma, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
    +
  • image (Image) –

  • +
  • sigma (int | float) –

  • +
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.gaussian_noise_sitk(image, mean, sigma, seed=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.min_max_intensity_sitk(image, *args, **kwargs)[source]
+
+
Return type:
+

Tuple[float, float]

+
+
Parameters:
+

image (Image) –

+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.rescale_intensity_sitk(image, output_min=None, output_max=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
    +
  • image (Image) –

  • +
  • output_min (int | float) –

  • +
  • output_max (int | float) –

  • +
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.rescale_intensity_window_sitk(image, input_min=None, input_max=None, output_min=None, output_max=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.transforms.intensity.intensity_utils_sitk.shift_scale_intensity_sitk(image, shift=None, scale=None, *args, **kwargs)[source]
+
+
Return type:
+

Image

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.rescale_intensity module

+
+
+class medipt.transforms.intensity.rescale_intensity.RescaleIntensity(new_min=None, new_max=None, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.intensity.shift_scale_intensity module

+
+
+class medipt.transforms.intensity.shift_scale_intensity.ShiftScaleIntensity(shift=None, scale=None, input_min=None, input_max=None, output_min=None, output_max=None, random_shift=None, random_scale=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+ +
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.transforms.spatial.functional_legacy.html b/documentation/medipt.transforms.spatial.functional_legacy.html new file mode 100644 index 0000000..473b69c --- /dev/null +++ b/documentation/medipt.transforms.spatial.functional_legacy.html @@ -0,0 +1,155 @@ + + + + + + + medipt.transforms.spatial.functional_legacy package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.transforms.spatial.functional_legacy package

+
+

Submodules

+
+
+

medipt.transforms.spatial.functional_legacy.flipping module

+
+
+

medipt.transforms.spatial.functional_legacy.rotation module

+
+
+

medipt.transforms.spatial.functional_legacy.scaling module

+
+
+

medipt.transforms.spatial.functional_legacy.translation module

+
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.transforms.spatial.html b/documentation/medipt.transforms.spatial.html new file mode 100644 index 0000000..ada7788 --- /dev/null +++ b/documentation/medipt.transforms.spatial.html @@ -0,0 +1,1169 @@ + + + + + + + medipt.transforms.spatial package — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.transforms.spatial package

+
+

Subpackages

+ +
+
+

Submodules

+
+
+

medipt.transforms.spatial.composite_transform module

+
+
+class medipt.transforms.spatial.composite_transform.CompositeTransform(*args, **kwargs)[source]
+

Bases: object

+
+
+add_transforms(transform)[source]
+
+
Parameters:
+

transform (List[SpatialTransform | Transform] | Tuple[SpatialTransform | Transform, ...] | SpatialTransform | Transform) –

+
+
+
+ +
+
+create_composite(dim=3)[source]
+
+
Return type:
+

Transform

+
+
Parameters:
+

dim (int) –

+
+
+
+ +
+
+create_inverse_composite(dim=3, use_displacement_field=False)[source]
+
+
Return type:
+

CompositeTransform

+
+
Parameters:
+
    +
  • dim (int) –

  • +
  • use_displacement_field (bool) –

  • +
+
+
+
+ +
+ +
+
+medipt.transforms.spatial.composite_transform.composite_transform(transforms, dim=3)[source]
+
+
Parameters:
+
    +
  • transforms (List[AffineTransform | BSplineTransform | DisplacementFieldTransform]) –

  • +
  • dim (int) –

  • +
+
+
+
+ +
+
+

medipt.transforms.spatial.elastic_deformation_transform module

+
+
+class medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: SpatialTransform

+

Rotation transformation base class.

+
+
Parameters:
+
+
+
+
+
+get_displacement_field(*args, **kwargs)[source]
+
+ +
+
+get_inverse_transform(*args, **kwargs)[source]
+

This determines the inverse transform for the elastic deformation.

+

Note: this is not suitable for proper resampling the transformed image back to the original state, but is +intended to be used with coordinate transforms. For image resampling, use the inverted deformation field. +:type args: +:param args: +:type kwargs: +:param kwargs: +:return:

+
+ +
+
+get_inverted_displacement_field(*args, **kwargs)[source]
+
+ +
+
+get_inverted_transform_from_displacement()[source]
+
+ +
+
+get_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+class medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationInputImage(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: ElasticDeformation

+
+
Parameters:
+
+
+
+
+
+get_transform_on_input(spline_params, num_grid_points=6, spline_order=3, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationOutputImage(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: ElasticDeformation

+
+
Parameters:
+
+
+
+
+
+get_transform_on_output(spline_params, num_grid_points=6, spline_order=3, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: ElasticDeformation

+
+
Parameters:
+
+
+
+
+
+get_random_spline_params(num_grid_points=(6, 6, 6), max_deformation_displacement=(25, 25, 25), *args, **kwargs)[source]
+
+
Return type:
+

ndarray

+
+
Parameters:
+
+
+
+
+ +
+
+get_random_transform(image_size, image_spacing, image_origin=None, image_direction=None, num_grid_points=6, max_deformation_displacement=25, spline_order=3, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformInputImage(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: RandomElasticDeformation

+
+
Parameters:
+
+
+
+
+
+get_random_transform_on_input(num_grid_points=6, max_deformation_displacement=25, spline_order=3, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformOutputImage(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: RandomElasticDeformation

+
+
Parameters:
+
+
+
+
+
+get_random_transform_on_output(num_grid_points=6, max_deformation_displacement=25, spline_order=3, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+

medipt.transforms.spatial.flipping_transform module

+
+
+class medipt.transforms.spatial.flipping_transform.FlippingTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: SpatialTransform

+
+
Parameters:
+
+
+
+
+
+get_transform(flip_axes, *args, **kwargs)[source]
+
+
Parameters:
+

flip_axes (List[float] | Tuple[float, ...] | float) –

+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.flipping_transform.RandomFlipping(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: FlippingTransform

+
+
Parameters:
+
+
+
+
+
+get_random_transform(flip_axes, *args, **kwargs)[source]
+
+
Parameters:
+

flip_axes (List[int | float | bool] | Tuple[int | float | bool, ...] | int | float | bool | integer | floating | ndarray) –

+
+
+
+ +
+ +
+
+

medipt.transforms.spatial.random_affine_transform module

+
+
+class medipt.transforms.spatial.random_affine_transform.RandomAffineTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: SpatialTransform

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.transforms.spatial.rotation_transform module

+
+
+class medipt.transforms.spatial.rotation_transform.RandomRotation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: RotationTransform, RandomAffineTransform

+

A rotation transformation with random angles (in radian).

+
+
Parameters:
+
+
+
+
+
+get_random_transform(min_angles=None, max_angles=None, transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.rotation_transform.RotationTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: SpatialTransform

+

Rotation transformation base class.

+
+
Parameters:
+
+
+
+
+
+get_transform(angles, *args, **kwargs)[source]
+
+
Parameters:
+

angles (List[float] | Tuple[float, ...] | float) –

+
+
+
+ +
+ +
+
+

medipt.transforms.spatial.scaling_transform module

+
+
+class medipt.transforms.spatial.scaling_transform.RandomScaling(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: ScalingTransform, RandomAffineTransform

+
+
Parameters:
+
+
+
+
+
+get_random_transform(min_scaling, max_scaling, transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.scaling_transform.RandomUniformScaling(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: ScalingTransform, RandomAffineTransform

+
+
Parameters:
+
+
+
+
+
+get_random_transform(min_scaling=None, max_scaling=None, transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.scaling_transform.ScalingTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: SpatialTransform

+

Scale transformation base class.

+
+
Parameters:
+
+
+
+
+
+get_scale_transform(dim, scale, direction)[source]
+

Returns the sitk transform based on the given parameters. +:type dim: +:param dim: The dimension. +:type scale: +:param scale: List of scale factors for each dimension. +:rtype: AffineTransform +:return: The sitk.AffineTransform().

+
+
Return type:
+

AffineTransform

+
+
+
+ +
+
+get_transform(scale, *args, **kwargs)[source]
+
+
Parameters:
+

scale (List[float] | Tuple[float, ...] | float | int) –

+
+
+
+ +
+ +
+
+

medipt.transforms.spatial.spatial_transform module

+
+
+class medipt.transforms.spatial.spatial_transform.SpatialTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: ABC

+

A generic spatial transform that can be applied to 2D and 3D images.

+
+
Parameters:
+
+
+
+
+
+get_displacement_field(*args, **kwargs)[source]
+
+ +
+
+get_image_params(image=None, image_size=None, image_spacing=None, image_origin=None, image_direction=None, *args, **kwargs)[source]
+
+
Return type:
+

Tuple[Union[List[Union[int, float]], Tuple[Union[int, float]], ndarray], Union[List[Union[int, float]], Tuple[Union[int, float]], ndarray], Union[List[Union[int, float]], Tuple[Union[int, float]], ndarray], Union[List[Union[int, float]], Tuple[Union[int, float]], ndarray]]

+
+
Parameters:
+
+
+
+
+ +
+
+get_input_center(*args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
+
+ +
+
+get_input_origin(*args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
+
+ +
+
+get_input_output_space(dict=None, *args, **kwargs)[source]
+
+
Parameters:
+

dict (dict) –

+
+
+
+ +
+
+get_inverse_transform(*args, **kwargs)[source]
+
+ +
+
+get_inverted_displacement_field(*args, **kwargs)[source]
+
+ +
+
+get_inverted_transform_from_displacement(*args, **kwargs)[source]
+
+ +
+
+get_output_center(*args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
+
+ +
+
+get_output_origin(*args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
+
+ +
+
+get_random_point(*args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
+
+ +
+ +
+
+

medipt.transforms.spatial.spatial_transform_init module

+
+
+class medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: object

+
+
Parameters:
+
+
+
+
+
+elastic_deformation_input_image(*args, **kwargs)[source]
+
+ +
+
+elastic_deformation_transform(*args, **kwargs)[source]
+
+ +
+
+flipping_transform(*args, **kwargs)[source]
+
+ +
+
+random_bbox_translation(*args, **kwargs)[source]
+
+ +
+
+random_coord_translation(*args, **kwargs)[source]
+
+ +
+
+random_elastic_deformation_input_image(*args, **kwargs)[source]
+
+ +
+
+random_elastic_deformation_output_image(*args, **kwargs)[source]
+
+ +
+
+random_elastic_deformation_transform(*args, **kwargs)[source]
+
+ +
+
+random_flipping_transform(*args, **kwargs)[source]
+
+ +
+
+random_rotation_transform(*args, **kwargs)[source]
+
+ +
+
+random_scaling_transform(*args, **kwargs)[source]
+
+ +
+
+random_translation_transform(*args, **kwargs)[source]
+
+ +
+
+random_uniform_scaling_transform(*args, **kwargs)[source]
+
+ +
+
+rotation_transform(*args, **kwargs)[source]
+
+ +
+
+scaling_transform(*args, **kwargs)[source]
+
+ +
+
+translate_input_center_to_input_origin(*args, **kwargs)[source]
+
+ +
+
+translate_input_center_to_output_center(*args, **kwargs)[source]
+
+ +
+
+translate_input_origin_to_output_center(*args, **kwargs)[source]
+
+ +
+
+translate_random_input_center_to_input_origin(*args, **kwargs)[source]
+
+ +
+
+translation_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+

medipt.transforms.spatial.translation_transform module

+
+
+class medipt.transforms.spatial.translation_transform.RandomBBoxTranslation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: RandomAffineTransform, TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_random_transform(transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+

transformation_dict (dict) –

+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.RandomCoordTranslation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, *args, **kwargs)[source]
+

Bases: RandomAffineTransform, TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_random_transform(coord, translation_extent, transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.RandomFactorInput(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: TranslationTransform

+

A translation transform that translates the input image by a random factor, such that it will be cropped. +The input center should usually be at the origin before this transformation. +The actual translation value per dimension will be calculated as follows: +(input_size[i] * input_spacing[i] - self.remove_border[i]) * float_uniform(-self.random_factor[i], self.random_factor[i]) for each dimension.

+
+
Parameters:
+
+
+
+
+
+get_transform(random_factor, remove_border=None, *args, **kwargs)[source]
+

Returns the sitk transform based on the given parameters. +:type kwargs: +:param kwargs: Must contain either ‘image’, or ‘input_size’ and ‘input_spacing’, which define the input image physical space. +:return: The sitk.AffineTransform().

+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.RandomTranslation(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: RandomAffineTransform, TranslationTransform

+

A translation transformation with a random offset.

+
+
Parameters:
+
+
+
+
+
+get_random_transform(min_trans, max_trans, transformation_dict=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.TranslateInputCenterToInputOrigin(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.TranslateInputCenterToOutputCenter(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.TranslateInputOriginToOutputCenter(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.TranslateRandomInputCenterToInputOrigin(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: TranslationTransform

+
+
Parameters:
+
+
+
+
+
+get_transform(*args, **kwargs)[source]
+
+ +
+ +
+
+class medipt.transforms.spatial.translation_transform.TranslationTransform(dim=3, used_dimensions=None, seed=None, legacy_random_state=True, rand_init=None, *args, **kwargs)[source]
+

Bases: SpatialTransform

+

Translation transformation base class.

+
+
Parameters:
+
+
+
+
+
+get_transform(translation, *args, **kwargs)[source]
+
+
Parameters:
+

translation (List[float] | Tuple[float, ...] | float) –

+
+
+
+ +
+ +
+
+

Module contents

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/medipt.utils.html b/documentation/medipt.utils.html new file mode 100644 index 0000000..2920926 --- /dev/null +++ b/documentation/medipt.utils.html @@ -0,0 +1,339 @@ + + + + + + + medipt.utils package — MedIPT + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

medipt.utils package

+
+

Submodules

+
+
+

medipt.utils.image_input_output_space module

+
+
+medipt.utils.image_input_output_space.resolve_input_output_space(dim=3, input_image=None, reference_image=None, input_size=None, output_size=None, input_spacing=None, output_spacing=None, input_direction=None, output_direction=None, input_origin=None, output_origin=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.utils.random_float module

+
+
+medipt.utils.random_float.initialize_rand_state(seed=None, legacy_random_state=True)[source]
+
+
Return type:
+

Union[ModuleType, Generator, BitGenerator]

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.utils.random_float.random_binomial(n, p, output_size=None, ignore_axis=None, seed=None, legacy_random_state=True, rand_init=None)[source]
+
+
Parameters:
+
+
+
Return type:
+

Union[ndarray, int]

+
+
Returns:
+

+
+
+
+ +
+
+medipt.utils.random_float.random_uniform_float(low_value, high_value, output_size=None, dim=None, seed=None, legacy_random_state=True, rand_init=None)[source]
+
+
Return type:
+

Union[float, List[float], ndarray]

+
+
Parameters:
+
+
+
+
+ +
+
+

medipt.utils.spatial_utils module

+
+
+medipt.utils.spatial_utils.get_output_size_from_spacing(dim, input_size, input_spacing, input_direction, output_spacing, output_direction=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+
+medipt.utils.spatial_utils.get_output_spacing_from_size(dim, input_size, input_spacing, input_direction, output_size, output_direction=None, *args, **kwargs)[source]
+
+
Parameters:
+
+
+
+
+ +
+
+medipt.utils.spatial_utils.image_center(input_size, *args, **kwargs)[source]
+
+
Parameters:
+

input_size (Tuple[int, ...]) –

+
+
+
+ +
+
+medipt.utils.spatial_utils.image_index_to_phys(dim, index_coords, image=None, size=None, origin=None, spacing=None, direction=None, *args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.utils.spatial_utils.physical_image_size(dim, size, spacing, direction, origin, *args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
Parameters:
+
+
+
+
+ +
+
+medipt.utils.spatial_utils.physical_image_size_no_origin(dim, size, spacing, direction, *args, **kwargs)[source]
+
+
Return type:
+

List[float]

+
+
Parameters:
+
+
+
+
+ +
+
+

Module contents

+
+
+medipt.utils.set_num_workers(n_threads)[source]
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/documentation/modules.html b/documentation/modules.html new file mode 100644 index 0000000..52c7e36 --- /dev/null +++ b/documentation/modules.html @@ -0,0 +1,146 @@ + + + + + + + medipt — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..887cc12 --- /dev/null +++ b/genindex.html @@ -0,0 +1,769 @@ + + + + + + Index — MedIPT + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ A + | C + | E + | F + | G + | I + | M + | P + | R + | S + | T + +
+

A

+ + +
+ +

C

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

I

+ + + +
+ +

M

+ + + +
    +
  • + medipt + +
  • +
  • + medipt.crop_image + +
  • +
  • + medipt.crop_image.threshold_crop_background + +
  • +
  • + medipt.resample_image + +
  • +
  • + medipt.resample_image.resample_image + +
  • +
  • + medipt.transforms + +
  • +
  • + medipt.transforms.intensity + +
  • +
  • + medipt.transforms.intensity.change_image_gamma + +
  • +
  • + medipt.transforms.intensity.clamp_intensity + +
  • +
  • + medipt.transforms.intensity.gaussian_blur + +
  • +
  • + medipt.transforms.intensity.gaussian_noise + +
  • +
  • + medipt.transforms.intensity.intensity_utils_np + +
  • +
  • + medipt.transforms.intensity.intensity_utils_sitk + +
  • +
  • + medipt.transforms.intensity.rescale_intensity + +
  • +
  • + medipt.transforms.intensity.shift_scale_intensity + +
  • +
  • + medipt.transforms.spatial + +
  • +
  • + medipt.transforms.spatial.composite_transform + +
  • +
  • + medipt.transforms.spatial.elastic_deformation_transform + +
  • +
  • + medipt.transforms.spatial.flipping_transform + +
  • +
  • + medipt.transforms.spatial.random_affine_transform + +
  • +
  • + medipt.transforms.spatial.rotation_transform + +
  • +
  • + medipt.transforms.spatial.scaling_transform + +
  • +
  • + medipt.transforms.spatial.spatial_transform + +
  • +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..63b1643 --- /dev/null +++ b/index.html @@ -0,0 +1,148 @@ + + + + + + + Welcome to ImageProcessingTools’s documentation! — MedIPT + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Welcome to ImageProcessingTools’s documentation!

+

Documentation for the ImageProcessingTools package.

+
+

Install Instructions:

+ +
+
+

Package References:

+ +
+
+
+
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/install/installation.html b/install/installation.html new file mode 100644 index 0000000..feb817b --- /dev/null +++ b/install/installation.html @@ -0,0 +1,151 @@ + + + + + + + Installation — MedIPT + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Installation

+

MedIPT is available for Python 3.7 to 3.11, and can be installed via pip or conda.

+
+

Installation via Anaconda

+

The easiest way to install MedIPT is with Anaconda and is available for all major OS platforms.

+

If SimpleITK is already installed, MedIPT can be installed with the following command: +.. code-block:

+
conda install -c medipt medipt
+
+
+

Otherwise, MedIPT can be installed with the following command: +.. code-block:

+
conda install -c medipt -c simpleitk -c medipt
+
+
+

On Windows, if SimpleITK is not installed, ensure conda-forge is being used to install. +.. code-block:

+
conda install -c medipt -c simpleitk -c conda-forge medipt
+
+
+
+
+

Installation via pip

+

Pip installation can be done by: +.. code-block:

+
pip install -i https://pypi.anaconda.org/medipt/simple medipt
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..3045f55 Binary files /dev/null and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 0000000..cf5fed8 --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,275 @@ + + + + + + Python Module Index — MedIPT + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ m +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ m
+ medipt +
    + medipt.crop_image +
    + medipt.crop_image.threshold_crop_background +
    + medipt.resample_image +
    + medipt.resample_image.resample_image +
    + medipt.transforms +
    + medipt.transforms.intensity +
    + medipt.transforms.intensity.change_image_gamma +
    + medipt.transforms.intensity.clamp_intensity +
    + medipt.transforms.intensity.gaussian_blur +
    + medipt.transforms.intensity.gaussian_noise +
    + medipt.transforms.intensity.intensity_utils_np +
    + medipt.transforms.intensity.intensity_utils_sitk +
    + medipt.transforms.intensity.rescale_intensity +
    + medipt.transforms.intensity.shift_scale_intensity +
    + medipt.transforms.spatial +
    + medipt.transforms.spatial.composite_transform +
    + medipt.transforms.spatial.elastic_deformation_transform +
    + medipt.transforms.spatial.flipping_transform +
    + medipt.transforms.spatial.random_affine_transform +
    + medipt.transforms.spatial.rotation_transform +
    + medipt.transforms.spatial.scaling_transform +
    + medipt.transforms.spatial.spatial_transform +
    + medipt.transforms.spatial.spatial_transform_init +
    + medipt.transforms.spatial.translation_transform +
    + medipt.transforms.transform_coordinate +
    + medipt.utils +
    + medipt.utils.image_input_output_space +
    + medipt.utils.random_float +
    + medipt.utils.spatial_utils +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..a02689f --- /dev/null +++ b/search.html @@ -0,0 +1,130 @@ + + + + + + Search — MedIPT + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..58201fa --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["documentation/medipt", "documentation/medipt.crop_image", "documentation/medipt.resample_image", "documentation/medipt.transforms", "documentation/medipt.transforms.intensity", "documentation/medipt.transforms.spatial", "documentation/medipt.transforms.spatial.functional_legacy", "documentation/medipt.utils", "documentation/modules", "index", "install/installation"], "filenames": ["documentation/medipt.rst", "documentation/medipt.crop_image.rst", "documentation/medipt.resample_image.rst", "documentation/medipt.transforms.rst", "documentation/medipt.transforms.intensity.rst", "documentation/medipt.transforms.spatial.rst", "documentation/medipt.transforms.spatial.functional_legacy.rst", "documentation/medipt.utils.rst", "documentation/modules.rst", "index.rst", "install/installation.rst"], "titles": ["medipt package", "medipt.crop_image package", "medipt.resample_image package", "medipt.transforms package", "medipt.transforms.intensity package", "medipt.transforms.spatial package", "medipt.transforms.spatial.functional_legacy package", "medipt.utils package", "medipt", "Welcome to ImageProcessingTools\u2019s documentation!", "Installation"], "terms": {"resample_imag": [0, 8], "submodul": [0, 8], "resampleimag": [0, 2], "get_imag": [0, 2], "get_resampled_imag": [0, 2], "get_simpleitk_pix_typ": [0, 2], "get_sitk_interpol": [0, 2], "transform": [0, 2, 8], "intens": [0, 3], "change_image_gamma": [0, 3], "clamp_intens": [0, 3], "gaussian_blur": [0, 3], "gaussian_nois": [0, 3], "intensity_utils_np": [0, 3], "intensity_utils_sitk": [0, 3], "rescale_intens": [0, 3], "shift_scale_intens": [0, 3], "spatial": [0, 3], "composite_transform": [0, 3], "elastic_deformation_transform": [0, 3], "flipping_transform": [0, 3], "random_affine_transform": [0, 3], "rotation_transform": [0, 3], "scaling_transform": [0, 3], "spatial_transform": [0, 3], "spatial_transform_init": [0, 3], "translation_transform": [0, 3], "transform_coordin": [0, 8], "transformcoordin": [0, 3], "util": [0, 8], "image_input_output_spac": [0, 8], "resolve_input_output_spac": [0, 7], "random_float": [0, 8], "initialize_rand_st": [0, 7], "random_binomi": [0, 7], "random_uniform_float": [0, 7], "spatial_util": [0, 8], "get_output_size_from_spac": [0, 7], "get_output_spacing_from_s": [0, 7], "image_cent": [0, 7], "image_index_to_phi": [0, 7], "physical_image_s": [0, 7], "physical_image_size_no_origin": [0, 7], "set_num_work": [0, 7], "imag": [1, 2, 4, 5, 7], "inside_valu": 1, "outside_valu": 1, "arg": [1, 2, 3, 4, 5, 7], "kwarg": [1, 2, 3, 4, 5, 7], "sourc": [1, 2, 3, 4, 5, 7], "return": [1, 2, 3, 4, 5, 7], "type": [1, 2, 3, 4, 5, 7], "paramet": [1, 2, 3, 4, 5, 7], "int": [1, 2, 3, 4, 5, 7], "float": [1, 2, 3, 4, 5, 7], "class": [2, 3, 4, 5], "interpol": 2, "linear": 2, "post_processing_sitk": 2, "none": [2, 4, 5, 7], "pixel_typ": 2, "float32": 2, "default_pixel_valu": 2, "dim": [2, 5, 7], "3": [2, 5, 7, 10], "used_dimens": [2, 5], "seed": [2, 4, 5, 7], "legacy_random_st": [2, 4, 5, 7], "true": [2, 4, 5, 7], "base": [2, 3, 4, 5], "object": [2, 3, 4, 5], "str": 2, "callabl": 2, "list": [2, 3, 5, 7], "tupl": [2, 3, 4, 5, 7], "bool": [2, 4, 5, 7], "randomst": [2, 4, 5, 7], "gener": [2, 4, 5, 7], "bitgener": [2, 4, 5, 7], "input_output_space_dict": 2, "reference_imag": [2, 7], "dict": [2, 5], "union": [2, 3, 5, 7], "simpleitk": [2, 10], "pixel": 2, "given": [2, 5], "string": 2, "The": [2, 5, 10], "sitk": [2, 5], "sitkfloat32": 2, "float64": 2, "sitkfloat64": 2, "int8": 2, "sitkint8": 2, "int16": 2, "sitkint16": 2, "int32": 2, "sitkint32": 2, "int64": 2, "sitkint64": 2, "uint8": 2, "sitkuint8": 2, "uint16": 2, "sitkuint16": 2, "uint32": 2, "sitkuint32": 2, "uint64": 2, "sitkuint64": 2, "complex64": 2, "sitkcomplexfloat32": 2, "complex128": 2, "sitkcomplexfloat64": 2, "an": 2, "nearest": 2, "sitknearestneighbor": 2, "sitklinear": 2, "cubic": 2, "sitkbsplin": 2, "label_gaussian": 2, "sitklabelgaussian": 2, "gaussian": 2, "sitkgaussian": 2, "lanczo": 2, "sitklanczoswindowedsinc": 2, "change_gamma": [3, 4], "change_gamma_unnorm": [3, 4], "random_change_gamma": [3, 4], "scale": [3, 4, 5], "clampintens": [3, 4], "gaussianblur": [3, 4], "randomgaussianblur": [3, 4], "gaussiannois": [3, 4], "randomgaussiannois": [3, 4], "change_image_gamma_np": [3, 4], "clamp_intensity_np": [3, 4], "gaussian_blur_np": [3, 4], "gaussian_noise_np": [3, 4], "rescale_intensity_np": [3, 4], "rescale_intensity_window_np": [3, 4], "shift_scale_intensity_np": [3, 4], "change_image_gamma_sitk": [3, 4], "clamp_intensity_sitk": [3, 4], "gaussian_blur_sitk": [3, 4], "gaussian_noise_sitk": [3, 4], "min_max_intensity_sitk": [3, 4], "rescale_intensity_sitk": [3, 4], "rescale_intensity_window_sitk": [3, 4], "shift_scale_intensity_sitk": [3, 4], "rescaleintens": [3, 4], "shiftscaleintens": [3, 4], "functional_legaci": [3, 5], "flip": [3, 5], "rotat": [3, 5], "translat": [3, 5], "compositetransform": [3, 5], "add_transform": [3, 5], "create_composit": [3, 5], "create_inverse_composit": [3, 5], "elasticdeform": [3, 5], "get_displacement_field": [3, 5], "get_inverse_transform": [3, 5], "get_inverted_displacement_field": [3, 5], "get_inverted_transform_from_displac": [3, 5], "get_transform": [3, 5], "elasticdeformationinputimag": [3, 5], "get_transform_on_input": [3, 5], "elasticdeformationoutputimag": [3, 5], "get_transform_on_output": [3, 5], "randomelasticdeform": [3, 5], "get_random_spline_param": [3, 5], "get_random_transform": [3, 5], "randomelasticdeformationtransforminputimag": [3, 5], "get_random_transform_on_input": [3, 5], "randomelasticdeformationtransformoutputimag": [3, 5], "get_random_transform_on_output": [3, 5], "flippingtransform": [3, 5], "randomflip": [3, 5], "randomaffinetransform": [3, 5], "randomrot": [3, 5], "rotationtransform": [3, 5], "randomsc": [3, 5], "randomuniformsc": [3, 5], "scalingtransform": [3, 5], "get_scale_transform": [3, 5], "spatialtransform": [3, 5], "get_image_param": [3, 5], "get_input_cent": [3, 5], "get_input_origin": [3, 5], "get_input_output_spac": [3, 5], "get_output_cent": [3, 5], "get_output_origin": [3, 5], "get_random_point": [3, 5], "spatialtransforminit": [3, 5], "elastic_deformation_input_imag": [3, 5], "random_bbox_transl": [3, 5], "random_coord_transl": [3, 5], "random_elastic_deformation_input_imag": [3, 5], "random_elastic_deformation_output_imag": [3, 5], "random_elastic_deformation_transform": [3, 5], "random_flipping_transform": [3, 5], "random_rotation_transform": [3, 5], "random_scaling_transform": [3, 5], "random_translation_transform": [3, 5], "random_uniform_scaling_transform": [3, 5], "translate_input_center_to_input_origin": [3, 5], "translate_input_center_to_output_cent": [3, 5], "translate_input_origin_to_output_cent": [3, 5], "translate_random_input_center_to_input_origin": [3, 5], "randombboxtransl": [3, 5], "randomcoordtransl": [3, 5], "randomfactorinput": [3, 5], "randomtransl": [3, 5], "translateinputcentertoinputorigin": [3, 5], "translateinputcentertooutputcent": [3, 5], "translateinputorigintooutputcent": [3, 5], "translaterandominputcentertoinputorigin": [3, 5], "translationtransform": [3, 5], "phys_coordin": 3, "img": 4, "l": 4, "lambda_min": 4, "0": 4, "5": 4, "lambda_max": 4, "1": 4, "old_rang": 4, "new_rang": 4, "window_min": 4, "window_max": 4, "sigma": 4, "min_sigma": 4, "max_sigma": 4, "mean": 4, "min_mean": 4, "max_mean": 4, "gamma": 4, "ndarrai": [4, 5, 7], "image_min": 4, "image_max": 4, "rand_init": [4, 5, 7], "output_min": 4, "output_max": 4, "input_min": 4, "input_max": 4, "shift": 4, "new_min": 4, "new_max": 4, "random_shift": 4, "random_scal": 4, "use_displacement_field": 5, "fals": 5, "affinetransform": 5, "bsplinetransform": 5, "displacementfieldtransform": 5, "thi": 5, "determin": 5, "invers": 5, "elast": 5, "deform": 5, "note": 5, "i": [5, 7, 10], "suitabl": 5, "proper": 5, "resampl": 5, "back": 5, "origin": [5, 7], "state": 5, "intend": 5, "us": [5, 10], "coordin": 5, "For": 5, "invert": 5, "field": 5, "param": 5, "spline_param": 5, "num_grid_point": 5, "6": 5, "spline_ord": 5, "max_deformation_displac": 5, "25": 5, "image_s": 5, "image_spac": 5, "image_origin": 5, "image_direct": 5, "flip_ax": 5, "integ": [5, 7], "A": 5, "random": 5, "angl": 5, "radian": 5, "min_angl": 5, "max_angl": 5, "transformation_dict": 5, "min_scal": 5, "max_scal": 5, "direct": [5, 7], "dimens": 5, "factor": 5, "each": 5, "rtype": 5, "abc": 5, "can": [5, 10], "appli": 5, "2d": 5, "3d": 5, "coord": 5, "translation_ext": 5, "input": 5, "crop": 5, "center": 5, "should": 5, "usual": 5, "befor": 5, "actual": 5, "valu": 5, "per": 5, "calcul": 5, "follow": [5, 10], "input_s": [5, 7], "input_spac": [5, 7], "self": 5, "remove_bord": 5, "float_uniform": 5, "random_factor": 5, "must": 5, "contain": 5, "either": 5, "which": 5, "defin": 5, "physic": 5, "space": [5, 7], "offset": 5, "min_tran": 5, "max_tran": 5, "input_imag": 7, "output_s": 7, "output_spac": 7, "input_direct": 7, "output_direct": 7, "input_origin": 7, "output_origin": 7, "moduletyp": 7, "n": 7, "p": 7, "ignore_axi": 7, "ignor": 7, "axi": 7, "specifi": 7, "If": [7, 10], "work": 7, "onli": 7, "1d": 7, "right": 7, "now": 7, "low_valu": 7, "high_valu": 7, "index_coord": 7, "size": 7, "n_thread": 7, "packag": 8, "subpackag": [8, 9], "modul": [8, 9], "content": [8, 9], "via": 9, "anaconda": 9, "pip": 9, "medipt": [9, 10], "index": 9, "search": 9, "page": 9, "avail": 10, "python": 10, "7": 10, "11": 10, "conda": 10, "easiest": 10, "wai": 10, "all": 10, "major": 10, "o": 10, "platform": 10, "alreadi": 10, "command": 10, "code": 10, "block": 10, "c": 10, "otherwis": 10, "On": 10, "window": 10, "ensur": 10, "forg": 10, "being": 10, "done": 10, "http": 10, "pypi": 10, "org": 10, "simpl": 10}, "objects": {"": [[0, 0, 0, "-", "medipt"]], "medipt": [[1, 0, 0, "-", "crop_image"], [2, 0, 0, "-", "resample_image"], [3, 0, 0, "-", "transforms"], [7, 0, 0, "-", "utils"]], "medipt.crop_image": [[1, 0, 0, "-", "threshold_crop_background"]], "medipt.crop_image.threshold_crop_background": [[1, 1, 1, "", "threshold_crop_background"]], "medipt.resample_image": [[2, 0, 0, "-", "resample_image"]], "medipt.resample_image.resample_image": [[2, 2, 1, "", "ResampleImage"], [2, 1, 1, "", "get_simpleitk_pix_type"], [2, 1, 1, "", "get_sitk_interpolator"]], "medipt.resample_image.resample_image.ResampleImage": [[2, 3, 1, "", "get_images"], [2, 3, 1, "", "get_resampled_images"], [2, 3, 1, "", "resample_image"]], "medipt.transforms": [[4, 0, 0, "-", "intensity"], [5, 0, 0, "-", "spatial"], [3, 0, 0, "-", "transform_coordinate"]], "medipt.transforms.intensity": [[4, 0, 0, "-", "change_image_gamma"], [4, 0, 0, "-", "clamp_intensity"], [4, 0, 0, "-", "gaussian_blur"], [4, 0, 0, "-", "gaussian_noise"], [4, 0, 0, "-", "intensity_utils_np"], [4, 0, 0, "-", "intensity_utils_sitk"], [4, 0, 0, "-", "rescale_intensity"], [4, 0, 0, "-", "shift_scale_intensity"]], "medipt.transforms.intensity.change_image_gamma": [[4, 1, 1, "", "change_gamma"], [4, 1, 1, "", "change_gamma_unnormalized"], [4, 1, 1, "", "random_change_gamma"], [4, 1, 1, "", "scale"]], "medipt.transforms.intensity.clamp_intensity": [[4, 2, 1, "", "ClampIntensity"]], "medipt.transforms.intensity.gaussian_blur": [[4, 2, 1, "", "GaussianBlur"], [4, 2, 1, "", "RandomGaussianBlur"]], "medipt.transforms.intensity.gaussian_noise": [[4, 2, 1, "", "GaussianNoise"], [4, 2, 1, "", "RandomGaussianNoise"]], "medipt.transforms.intensity.intensity_utils_np": [[4, 1, 1, "", "change_image_gamma_np"], [4, 1, 1, "", "clamp_intensity_np"], [4, 1, 1, "", "gaussian_blur_np"], [4, 1, 1, "", "gaussian_noise_np"], [4, 1, 1, "", "rescale_intensity_np"], [4, 1, 1, "", "rescale_intensity_window_np"], [4, 1, 1, "", "shift_scale_intensity_np"]], "medipt.transforms.intensity.intensity_utils_sitk": [[4, 1, 1, "", "change_image_gamma_sitk"], [4, 1, 1, "", "clamp_intensity_sitk"], [4, 1, 1, "", "gaussian_blur_sitk"], [4, 1, 1, "", "gaussian_noise_sitk"], [4, 1, 1, "", "min_max_intensity_sitk"], [4, 1, 1, "", "rescale_intensity_sitk"], [4, 1, 1, "", "rescale_intensity_window_sitk"], [4, 1, 1, "", "shift_scale_intensity_sitk"]], "medipt.transforms.intensity.rescale_intensity": [[4, 2, 1, "", "RescaleIntensity"]], "medipt.transforms.intensity.shift_scale_intensity": [[4, 2, 1, "", "ShiftScaleIntensity"]], "medipt.transforms.spatial": [[5, 0, 0, "-", "composite_transform"], [5, 0, 0, "-", "elastic_deformation_transform"], [5, 0, 0, "-", "flipping_transform"], [5, 0, 0, "-", "random_affine_transform"], [5, 0, 0, "-", "rotation_transform"], [5, 0, 0, "-", "scaling_transform"], [5, 0, 0, "-", "spatial_transform"], [5, 0, 0, "-", "spatial_transform_init"], [5, 0, 0, "-", "translation_transform"]], "medipt.transforms.spatial.composite_transform": [[5, 2, 1, "", "CompositeTransform"], [5, 1, 1, "", "composite_transform"]], "medipt.transforms.spatial.composite_transform.CompositeTransform": [[5, 3, 1, "", "add_transforms"], [5, 3, 1, "", "create_composite"], [5, 3, 1, "", "create_inverse_composite"]], "medipt.transforms.spatial.elastic_deformation_transform": [[5, 2, 1, "", "ElasticDeformation"], [5, 2, 1, "", "ElasticDeformationInputImage"], [5, 2, 1, "", "ElasticDeformationOutputImage"], [5, 2, 1, "", "RandomElasticDeformation"], [5, 2, 1, "", "RandomElasticDeformationTransformInputImage"], [5, 2, 1, "", "RandomElasticDeformationTransformOutputImage"]], "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation": [[5, 3, 1, "", "get_displacement_field"], [5, 3, 1, "", "get_inverse_transform"], [5, 3, 1, "", "get_inverted_displacement_field"], [5, 3, 1, "", "get_inverted_transform_from_displacement"], [5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationInputImage": [[5, 3, 1, "", "get_transform_on_input"]], "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationOutputImage": [[5, 3, 1, "", "get_transform_on_output"]], "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformation": [[5, 3, 1, "", "get_random_spline_params"], [5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformInputImage": [[5, 3, 1, "", "get_random_transform_on_input"]], "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformOutputImage": [[5, 3, 1, "", "get_random_transform_on_output"]], "medipt.transforms.spatial.flipping_transform": [[5, 2, 1, "", "FlippingTransform"], [5, 2, 1, "", "RandomFlipping"]], "medipt.transforms.spatial.flipping_transform.FlippingTransform": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.flipping_transform.RandomFlipping": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.random_affine_transform": [[5, 2, 1, "", "RandomAffineTransform"]], "medipt.transforms.spatial.rotation_transform": [[5, 2, 1, "", "RandomRotation"], [5, 2, 1, "", "RotationTransform"]], "medipt.transforms.spatial.rotation_transform.RandomRotation": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.rotation_transform.RotationTransform": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.scaling_transform": [[5, 2, 1, "", "RandomScaling"], [5, 2, 1, "", "RandomUniformScaling"], [5, 2, 1, "", "ScalingTransform"]], "medipt.transforms.spatial.scaling_transform.RandomScaling": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.scaling_transform.RandomUniformScaling": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.scaling_transform.ScalingTransform": [[5, 3, 1, "", "get_scale_transform"], [5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.spatial_transform": [[5, 2, 1, "", "SpatialTransform"]], "medipt.transforms.spatial.spatial_transform.SpatialTransform": [[5, 3, 1, "", "get_displacement_field"], [5, 3, 1, "", "get_image_params"], [5, 3, 1, "", "get_input_center"], [5, 3, 1, "", "get_input_origin"], [5, 3, 1, "", "get_input_output_space"], [5, 3, 1, "", "get_inverse_transform"], [5, 3, 1, "", "get_inverted_displacement_field"], [5, 3, 1, "", "get_inverted_transform_from_displacement"], [5, 3, 1, "", "get_output_center"], [5, 3, 1, "", "get_output_origin"], [5, 3, 1, "", "get_random_point"]], "medipt.transforms.spatial.spatial_transform_init": [[5, 2, 1, "", "SpatialTransformInit"]], "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit": [[5, 3, 1, "", "elastic_deformation_input_image"], [5, 3, 1, "", "elastic_deformation_transform"], [5, 3, 1, "", "flipping_transform"], [5, 3, 1, "", "random_bbox_translation"], [5, 3, 1, "", "random_coord_translation"], [5, 3, 1, "", "random_elastic_deformation_input_image"], [5, 3, 1, "", "random_elastic_deformation_output_image"], [5, 3, 1, "", "random_elastic_deformation_transform"], [5, 3, 1, "", "random_flipping_transform"], [5, 3, 1, "", "random_rotation_transform"], [5, 3, 1, "", "random_scaling_transform"], [5, 3, 1, "", "random_translation_transform"], [5, 3, 1, "", "random_uniform_scaling_transform"], [5, 3, 1, "", "rotation_transform"], [5, 3, 1, "", "scaling_transform"], [5, 3, 1, "", "translate_input_center_to_input_origin"], [5, 3, 1, "", "translate_input_center_to_output_center"], [5, 3, 1, "", "translate_input_origin_to_output_center"], [5, 3, 1, "", "translate_random_input_center_to_input_origin"], [5, 3, 1, "", "translation_transform"]], "medipt.transforms.spatial.translation_transform": [[5, 2, 1, "", "RandomBBoxTranslation"], [5, 2, 1, "", "RandomCoordTranslation"], [5, 2, 1, "", "RandomFactorInput"], [5, 2, 1, "", "RandomTranslation"], [5, 2, 1, "", "TranslateInputCenterToInputOrigin"], [5, 2, 1, "", "TranslateInputCenterToOutputCenter"], [5, 2, 1, "", "TranslateInputOriginToOutputCenter"], [5, 2, 1, "", "TranslateRandomInputCenterToInputOrigin"], [5, 2, 1, "", "TranslationTransform"]], "medipt.transforms.spatial.translation_transform.RandomBBoxTranslation": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.translation_transform.RandomCoordTranslation": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.translation_transform.RandomFactorInput": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.translation_transform.RandomTranslation": [[5, 3, 1, "", "get_random_transform"]], "medipt.transforms.spatial.translation_transform.TranslateInputCenterToInputOrigin": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.translation_transform.TranslateInputCenterToOutputCenter": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.translation_transform.TranslateInputOriginToOutputCenter": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.translation_transform.TranslateRandomInputCenterToInputOrigin": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.spatial.translation_transform.TranslationTransform": [[5, 3, 1, "", "get_transform"]], "medipt.transforms.transform_coordinate": [[3, 2, 1, "", "TransformCoordinate"]], "medipt.transforms.transform_coordinate.TransformCoordinate": [[3, 3, 1, "", "transform_coordinate"]], "medipt.utils": [[7, 0, 0, "-", "image_input_output_space"], [7, 0, 0, "-", "random_float"], [7, 1, 1, "", "set_num_workers"], [7, 0, 0, "-", "spatial_utils"]], "medipt.utils.image_input_output_space": [[7, 1, 1, "", "resolve_input_output_space"]], "medipt.utils.random_float": [[7, 1, 1, "", "initialize_rand_state"], [7, 1, 1, "", "random_binomial"], [7, 1, 1, "", "random_uniform_float"]], "medipt.utils.spatial_utils": [[7, 1, 1, "", "get_output_size_from_spacing"], [7, 1, 1, "", "get_output_spacing_from_size"], [7, 1, 1, "", "image_center"], [7, 1, 1, "", "image_index_to_phys"], [7, 1, 1, "", "physical_image_size"], [7, 1, 1, "", "physical_image_size_no_origin"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"medipt": [0, 1, 2, 3, 4, 5, 6, 7, 8], "packag": [0, 1, 2, 3, 4, 5, 6, 7, 9], "subpackag": [0, 3, 5], "modul": [0, 1, 2, 3, 4, 5, 6, 7], "content": [0, 1, 2, 3, 4, 5, 6, 7], "crop_imag": 1, "submodul": [1, 2, 3, 4, 5, 6, 7], "threshold_crop_background": 1, "resample_imag": 2, "transform": [3, 4, 5, 6], "transform_coordin": 3, "intens": 4, "change_image_gamma": 4, "clamp_intens": 4, "gaussian_blur": 4, "gaussian_nois": 4, "intensity_utils_np": 4, "intensity_utils_sitk": 4, "rescale_intens": 4, "shift_scale_intens": 4, "spatial": [5, 6], "composite_transform": 5, "elastic_deformation_transform": 5, "flipping_transform": 5, "random_affine_transform": 5, "rotation_transform": 5, "scaling_transform": 5, "spatial_transform": 5, "spatial_transform_init": 5, "translation_transform": 5, "functional_legaci": 6, "flip": 6, "rotat": 6, "scale": 6, "translat": 6, "util": 7, "image_input_output_spac": 7, "random_float": 7, "spatial_util": 7, "welcom": 9, "imageprocessingtool": 9, "": 9, "document": 9, "instal": [9, 10], "instruct": 9, "refer": 9, "indic": 9, "tabl": 9, "via": 10, "anaconda": 10, "pip": 10}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"medipt package": [[0, "medipt-package"]], "Subpackages": [[0, "subpackages"], [3, "subpackages"], [5, "subpackages"]], "Module contents": [[0, "module-medipt"], [1, "module-medipt.crop_image"], [2, "module-medipt.resample_image"], [3, "module-medipt.transforms"], [4, "module-medipt.transforms.intensity"], [5, "module-medipt.transforms.spatial"], [6, "module-contents"], [7, "module-medipt.utils"]], "medipt.crop_image package": [[1, "medipt-crop-image-package"]], "Submodules": [[1, "submodules"], [2, "submodules"], [3, "submodules"], [4, "submodules"], [5, "submodules"], [6, "submodules"], [7, "submodules"]], "medipt.crop_image.threshold_crop_background module": [[1, "module-medipt.crop_image.threshold_crop_background"]], "medipt.resample_image package": [[2, "medipt-resample-image-package"]], "medipt.resample_image.resample_image module": [[2, "module-medipt.resample_image.resample_image"]], "medipt.transforms package": [[3, "medipt-transforms-package"]], "medipt.transforms.transform_coordinate module": [[3, "module-medipt.transforms.transform_coordinate"]], "medipt.transforms.intensity package": [[4, "medipt-transforms-intensity-package"]], "medipt.transforms.intensity.change_image_gamma module": [[4, "module-medipt.transforms.intensity.change_image_gamma"]], "medipt.transforms.intensity.clamp_intensity module": [[4, "module-medipt.transforms.intensity.clamp_intensity"]], "medipt.transforms.intensity.gaussian_blur module": [[4, "module-medipt.transforms.intensity.gaussian_blur"]], "medipt.transforms.intensity.gaussian_noise module": [[4, "module-medipt.transforms.intensity.gaussian_noise"]], "medipt.transforms.intensity.intensity_utils_np module": [[4, "module-medipt.transforms.intensity.intensity_utils_np"]], "medipt.transforms.intensity.intensity_utils_sitk module": [[4, "module-medipt.transforms.intensity.intensity_utils_sitk"]], "medipt.transforms.intensity.rescale_intensity module": [[4, "module-medipt.transforms.intensity.rescale_intensity"]], "medipt.transforms.intensity.shift_scale_intensity module": [[4, "module-medipt.transforms.intensity.shift_scale_intensity"]], "medipt.transforms.spatial package": [[5, "medipt-transforms-spatial-package"]], "medipt.transforms.spatial.composite_transform module": [[5, "module-medipt.transforms.spatial.composite_transform"]], "medipt.transforms.spatial.elastic_deformation_transform module": [[5, "module-medipt.transforms.spatial.elastic_deformation_transform"]], "medipt.transforms.spatial.flipping_transform module": [[5, "module-medipt.transforms.spatial.flipping_transform"]], "medipt.transforms.spatial.random_affine_transform module": [[5, "module-medipt.transforms.spatial.random_affine_transform"]], "medipt.transforms.spatial.rotation_transform module": [[5, "module-medipt.transforms.spatial.rotation_transform"]], "medipt.transforms.spatial.scaling_transform module": [[5, "module-medipt.transforms.spatial.scaling_transform"]], "medipt.transforms.spatial.spatial_transform module": [[5, "module-medipt.transforms.spatial.spatial_transform"]], "medipt.transforms.spatial.spatial_transform_init module": [[5, "module-medipt.transforms.spatial.spatial_transform_init"]], "medipt.transforms.spatial.translation_transform module": [[5, "module-medipt.transforms.spatial.translation_transform"]], "medipt.transforms.spatial.functional_legacy package": [[6, "medipt-transforms-spatial-functional-legacy-package"]], "medipt.transforms.spatial.functional_legacy.flipping module": [[6, "medipt-transforms-spatial-functional-legacy-flipping-module"]], "medipt.transforms.spatial.functional_legacy.rotation module": [[6, "medipt-transforms-spatial-functional-legacy-rotation-module"]], "medipt.transforms.spatial.functional_legacy.scaling module": [[6, "medipt-transforms-spatial-functional-legacy-scaling-module"]], "medipt.transforms.spatial.functional_legacy.translation module": [[6, "medipt-transforms-spatial-functional-legacy-translation-module"]], "medipt.utils package": [[7, "medipt-utils-package"]], "medipt.utils.image_input_output_space module": [[7, "module-medipt.utils.image_input_output_space"]], "medipt.utils.random_float module": [[7, "module-medipt.utils.random_float"]], "medipt.utils.spatial_utils module": [[7, "module-medipt.utils.spatial_utils"]], "medipt": [[8, "medipt"]], "Welcome to ImageProcessingTools\u2019s documentation!": [[9, "welcome-to-imageprocessingtools-s-documentation"]], "Install Instructions:": [[9, null]], "Package References:": [[9, null]], "Indices and tables": [[9, "indices-and-tables"]], "Installation": [[10, "installation"]], "Installation via Anaconda": [[10, "installation-via-anaconda"]], "Installation via pip": [[10, "installation-via-pip"]]}, "indexentries": {"medipt": [[0, "module-medipt"]], "module": [[0, "module-medipt"], [1, "module-medipt.crop_image"], [1, "module-medipt.crop_image.threshold_crop_background"], [2, "module-medipt.resample_image"], [2, "module-medipt.resample_image.resample_image"], [3, "module-medipt.transforms"], [3, "module-medipt.transforms.transform_coordinate"], [4, "module-medipt.transforms.intensity"], [4, "module-medipt.transforms.intensity.change_image_gamma"], [4, "module-medipt.transforms.intensity.clamp_intensity"], [4, "module-medipt.transforms.intensity.gaussian_blur"], [4, "module-medipt.transforms.intensity.gaussian_noise"], [4, "module-medipt.transforms.intensity.intensity_utils_np"], [4, "module-medipt.transforms.intensity.intensity_utils_sitk"], [4, "module-medipt.transforms.intensity.rescale_intensity"], [4, "module-medipt.transforms.intensity.shift_scale_intensity"], [5, "module-medipt.transforms.spatial"], [5, "module-medipt.transforms.spatial.composite_transform"], [5, "module-medipt.transforms.spatial.elastic_deformation_transform"], [5, "module-medipt.transforms.spatial.flipping_transform"], [5, "module-medipt.transforms.spatial.random_affine_transform"], [5, "module-medipt.transforms.spatial.rotation_transform"], [5, "module-medipt.transforms.spatial.scaling_transform"], [5, "module-medipt.transforms.spatial.spatial_transform"], [5, "module-medipt.transforms.spatial.spatial_transform_init"], [5, "module-medipt.transforms.spatial.translation_transform"], [7, "module-medipt.utils"], [7, "module-medipt.utils.image_input_output_space"], [7, "module-medipt.utils.random_float"], [7, "module-medipt.utils.spatial_utils"]], "medipt.crop_image": [[1, "module-medipt.crop_image"]], "medipt.crop_image.threshold_crop_background": [[1, "module-medipt.crop_image.threshold_crop_background"]], "threshold_crop_background() (in module medipt.crop_image.threshold_crop_background)": [[1, "medipt.crop_image.threshold_crop_background.threshold_crop_background"]], "resampleimage (class in medipt.resample_image.resample_image)": [[2, "medipt.resample_image.resample_image.ResampleImage"]], "get_images() (medipt.resample_image.resample_image.resampleimage method)": [[2, "medipt.resample_image.resample_image.ResampleImage.get_images"]], "get_resampled_images() (medipt.resample_image.resample_image.resampleimage method)": [[2, "medipt.resample_image.resample_image.ResampleImage.get_resampled_images"]], "get_simpleitk_pix_type() (in module medipt.resample_image.resample_image)": [[2, "medipt.resample_image.resample_image.get_simpleitk_pix_type"]], "get_sitk_interpolator() (in module medipt.resample_image.resample_image)": [[2, "medipt.resample_image.resample_image.get_sitk_interpolator"]], "medipt.resample_image": [[2, "module-medipt.resample_image"]], "medipt.resample_image.resample_image": [[2, "module-medipt.resample_image.resample_image"]], "resample_image() (medipt.resample_image.resample_image.resampleimage method)": [[2, "medipt.resample_image.resample_image.ResampleImage.resample_image"]], "transformcoordinate (class in medipt.transforms.transform_coordinate)": [[3, "medipt.transforms.transform_coordinate.TransformCoordinate"]], "medipt.transforms": [[3, "module-medipt.transforms"]], "medipt.transforms.transform_coordinate": [[3, "module-medipt.transforms.transform_coordinate"]], "transform_coordinate() (medipt.transforms.transform_coordinate.transformcoordinate method)": [[3, "medipt.transforms.transform_coordinate.TransformCoordinate.transform_coordinate"]], "clampintensity (class in medipt.transforms.intensity.clamp_intensity)": [[4, "medipt.transforms.intensity.clamp_intensity.ClampIntensity"]], "gaussianblur (class in medipt.transforms.intensity.gaussian_blur)": [[4, "medipt.transforms.intensity.gaussian_blur.GaussianBlur"]], "gaussiannoise (class in medipt.transforms.intensity.gaussian_noise)": [[4, "medipt.transforms.intensity.gaussian_noise.GaussianNoise"]], "randomgaussianblur (class in medipt.transforms.intensity.gaussian_blur)": [[4, "medipt.transforms.intensity.gaussian_blur.RandomGaussianBlur"]], "randomgaussiannoise (class in medipt.transforms.intensity.gaussian_noise)": [[4, "medipt.transforms.intensity.gaussian_noise.RandomGaussianNoise"]], "rescaleintensity (class in medipt.transforms.intensity.rescale_intensity)": [[4, "medipt.transforms.intensity.rescale_intensity.RescaleIntensity"]], "shiftscaleintensity (class in medipt.transforms.intensity.shift_scale_intensity)": [[4, "medipt.transforms.intensity.shift_scale_intensity.ShiftScaleIntensity"]], "change_gamma() (in module medipt.transforms.intensity.change_image_gamma)": [[4, "medipt.transforms.intensity.change_image_gamma.change_gamma"]], "change_gamma_unnormalized() (in module medipt.transforms.intensity.change_image_gamma)": [[4, "medipt.transforms.intensity.change_image_gamma.change_gamma_unnormalized"]], "change_image_gamma_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.change_image_gamma_np"]], "change_image_gamma_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.change_image_gamma_sitk"]], "clamp_intensity_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.clamp_intensity_np"]], "clamp_intensity_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.clamp_intensity_sitk"]], "gaussian_blur_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.gaussian_blur_np"]], "gaussian_blur_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.gaussian_blur_sitk"]], "gaussian_noise_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.gaussian_noise_np"]], "gaussian_noise_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.gaussian_noise_sitk"]], "medipt.transforms.intensity": [[4, "module-medipt.transforms.intensity"]], "medipt.transforms.intensity.change_image_gamma": [[4, "module-medipt.transforms.intensity.change_image_gamma"]], "medipt.transforms.intensity.clamp_intensity": [[4, "module-medipt.transforms.intensity.clamp_intensity"]], "medipt.transforms.intensity.gaussian_blur": [[4, "module-medipt.transforms.intensity.gaussian_blur"]], "medipt.transforms.intensity.gaussian_noise": [[4, "module-medipt.transforms.intensity.gaussian_noise"]], "medipt.transforms.intensity.intensity_utils_np": [[4, "module-medipt.transforms.intensity.intensity_utils_np"]], "medipt.transforms.intensity.intensity_utils_sitk": [[4, "module-medipt.transforms.intensity.intensity_utils_sitk"]], "medipt.transforms.intensity.rescale_intensity": [[4, "module-medipt.transforms.intensity.rescale_intensity"]], "medipt.transforms.intensity.shift_scale_intensity": [[4, "module-medipt.transforms.intensity.shift_scale_intensity"]], "min_max_intensity_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.min_max_intensity_sitk"]], "random_change_gamma() (in module medipt.transforms.intensity.change_image_gamma)": [[4, "medipt.transforms.intensity.change_image_gamma.random_change_gamma"]], "rescale_intensity_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.rescale_intensity_np"]], "rescale_intensity_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.rescale_intensity_sitk"]], "rescale_intensity_window_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.rescale_intensity_window_np"]], "rescale_intensity_window_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.rescale_intensity_window_sitk"]], "scale() (in module medipt.transforms.intensity.change_image_gamma)": [[4, "medipt.transforms.intensity.change_image_gamma.scale"]], "shift_scale_intensity_np() (in module medipt.transforms.intensity.intensity_utils_np)": [[4, "medipt.transforms.intensity.intensity_utils_np.shift_scale_intensity_np"]], "shift_scale_intensity_sitk() (in module medipt.transforms.intensity.intensity_utils_sitk)": [[4, "medipt.transforms.intensity.intensity_utils_sitk.shift_scale_intensity_sitk"]], "compositetransform (class in medipt.transforms.spatial.composite_transform)": [[5, "medipt.transforms.spatial.composite_transform.CompositeTransform"]], "elasticdeformation (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation"]], "elasticdeformationinputimage (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationInputImage"]], "elasticdeformationoutputimage (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationOutputImage"]], "flippingtransform (class in medipt.transforms.spatial.flipping_transform)": [[5, "medipt.transforms.spatial.flipping_transform.FlippingTransform"]], "randomaffinetransform (class in medipt.transforms.spatial.random_affine_transform)": [[5, "medipt.transforms.spatial.random_affine_transform.RandomAffineTransform"]], "randombboxtranslation (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.RandomBBoxTranslation"]], "randomcoordtranslation (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.RandomCoordTranslation"]], "randomelasticdeformation (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformation"]], "randomelasticdeformationtransforminputimage (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformInputImage"]], "randomelasticdeformationtransformoutputimage (class in medipt.transforms.spatial.elastic_deformation_transform)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformOutputImage"]], "randomfactorinput (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.RandomFactorInput"]], "randomflipping (class in medipt.transforms.spatial.flipping_transform)": [[5, "medipt.transforms.spatial.flipping_transform.RandomFlipping"]], "randomrotation (class in medipt.transforms.spatial.rotation_transform)": [[5, "medipt.transforms.spatial.rotation_transform.RandomRotation"]], "randomscaling (class in medipt.transforms.spatial.scaling_transform)": [[5, "medipt.transforms.spatial.scaling_transform.RandomScaling"]], "randomtranslation (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.RandomTranslation"]], "randomuniformscaling (class in medipt.transforms.spatial.scaling_transform)": [[5, "medipt.transforms.spatial.scaling_transform.RandomUniformScaling"]], "rotationtransform (class in medipt.transforms.spatial.rotation_transform)": [[5, "medipt.transforms.spatial.rotation_transform.RotationTransform"]], "scalingtransform (class in medipt.transforms.spatial.scaling_transform)": [[5, "medipt.transforms.spatial.scaling_transform.ScalingTransform"]], "spatialtransform (class in medipt.transforms.spatial.spatial_transform)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform"]], "spatialtransforminit (class in medipt.transforms.spatial.spatial_transform_init)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit"]], "translateinputcentertoinputorigin (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputCenterToInputOrigin"]], "translateinputcentertooutputcenter (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputCenterToOutputCenter"]], "translateinputorigintooutputcenter (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputOriginToOutputCenter"]], "translaterandominputcentertoinputorigin (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.TranslateRandomInputCenterToInputOrigin"]], "translationtransform (class in medipt.transforms.spatial.translation_transform)": [[5, "medipt.transforms.spatial.translation_transform.TranslationTransform"]], "add_transforms() (medipt.transforms.spatial.composite_transform.compositetransform method)": [[5, "medipt.transforms.spatial.composite_transform.CompositeTransform.add_transforms"]], "composite_transform() (in module medipt.transforms.spatial.composite_transform)": [[5, "medipt.transforms.spatial.composite_transform.composite_transform"]], "create_composite() (medipt.transforms.spatial.composite_transform.compositetransform method)": [[5, "medipt.transforms.spatial.composite_transform.CompositeTransform.create_composite"]], "create_inverse_composite() (medipt.transforms.spatial.composite_transform.compositetransform method)": [[5, "medipt.transforms.spatial.composite_transform.CompositeTransform.create_inverse_composite"]], "elastic_deformation_input_image() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.elastic_deformation_input_image"]], "elastic_deformation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.elastic_deformation_transform"]], "flipping_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.flipping_transform"]], "get_displacement_field() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation.get_displacement_field"]], "get_displacement_field() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_displacement_field"]], "get_image_params() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_image_params"]], "get_input_center() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_input_center"]], "get_input_origin() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_input_origin"]], "get_input_output_space() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_input_output_space"]], "get_inverse_transform() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation.get_inverse_transform"]], "get_inverse_transform() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_inverse_transform"]], "get_inverted_displacement_field() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation.get_inverted_displacement_field"]], "get_inverted_displacement_field() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_inverted_displacement_field"]], "get_inverted_transform_from_displacement() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation.get_inverted_transform_from_displacement"]], "get_inverted_transform_from_displacement() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_inverted_transform_from_displacement"]], "get_output_center() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_output_center"]], "get_output_origin() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_output_origin"]], "get_random_point() (medipt.transforms.spatial.spatial_transform.spatialtransform method)": [[5, "medipt.transforms.spatial.spatial_transform.SpatialTransform.get_random_point"]], "get_random_spline_params() (medipt.transforms.spatial.elastic_deformation_transform.randomelasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformation.get_random_spline_params"]], "get_random_transform() (medipt.transforms.spatial.elastic_deformation_transform.randomelasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformation.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.flipping_transform.randomflipping method)": [[5, "medipt.transforms.spatial.flipping_transform.RandomFlipping.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.rotation_transform.randomrotation method)": [[5, "medipt.transforms.spatial.rotation_transform.RandomRotation.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.scaling_transform.randomscaling method)": [[5, "medipt.transforms.spatial.scaling_transform.RandomScaling.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.scaling_transform.randomuniformscaling method)": [[5, "medipt.transforms.spatial.scaling_transform.RandomUniformScaling.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.translation_transform.randombboxtranslation method)": [[5, "medipt.transforms.spatial.translation_transform.RandomBBoxTranslation.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.translation_transform.randomcoordtranslation method)": [[5, "medipt.transforms.spatial.translation_transform.RandomCoordTranslation.get_random_transform"]], "get_random_transform() (medipt.transforms.spatial.translation_transform.randomtranslation method)": [[5, "medipt.transforms.spatial.translation_transform.RandomTranslation.get_random_transform"]], "get_random_transform_on_input() (medipt.transforms.spatial.elastic_deformation_transform.randomelasticdeformationtransforminputimage method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformInputImage.get_random_transform_on_input"]], "get_random_transform_on_output() (medipt.transforms.spatial.elastic_deformation_transform.randomelasticdeformationtransformoutputimage method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.RandomElasticDeformationTransformOutputImage.get_random_transform_on_output"]], "get_scale_transform() (medipt.transforms.spatial.scaling_transform.scalingtransform method)": [[5, "medipt.transforms.spatial.scaling_transform.ScalingTransform.get_scale_transform"]], "get_transform() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformation method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformation.get_transform"]], "get_transform() (medipt.transforms.spatial.flipping_transform.flippingtransform method)": [[5, "medipt.transforms.spatial.flipping_transform.FlippingTransform.get_transform"]], "get_transform() (medipt.transforms.spatial.rotation_transform.rotationtransform method)": [[5, "medipt.transforms.spatial.rotation_transform.RotationTransform.get_transform"]], "get_transform() (medipt.transforms.spatial.scaling_transform.scalingtransform method)": [[5, "medipt.transforms.spatial.scaling_transform.ScalingTransform.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.randomfactorinput method)": [[5, "medipt.transforms.spatial.translation_transform.RandomFactorInput.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.translateinputcentertoinputorigin method)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputCenterToInputOrigin.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.translateinputcentertooutputcenter method)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputCenterToOutputCenter.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.translateinputorigintooutputcenter method)": [[5, "medipt.transforms.spatial.translation_transform.TranslateInputOriginToOutputCenter.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.translaterandominputcentertoinputorigin method)": [[5, "medipt.transforms.spatial.translation_transform.TranslateRandomInputCenterToInputOrigin.get_transform"]], "get_transform() (medipt.transforms.spatial.translation_transform.translationtransform method)": [[5, "medipt.transforms.spatial.translation_transform.TranslationTransform.get_transform"]], "get_transform_on_input() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformationinputimage method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationInputImage.get_transform_on_input"]], "get_transform_on_output() (medipt.transforms.spatial.elastic_deformation_transform.elasticdeformationoutputimage method)": [[5, "medipt.transforms.spatial.elastic_deformation_transform.ElasticDeformationOutputImage.get_transform_on_output"]], "medipt.transforms.spatial": [[5, "module-medipt.transforms.spatial"]], "medipt.transforms.spatial.composite_transform": [[5, "module-medipt.transforms.spatial.composite_transform"]], "medipt.transforms.spatial.elastic_deformation_transform": [[5, "module-medipt.transforms.spatial.elastic_deformation_transform"]], "medipt.transforms.spatial.flipping_transform": [[5, "module-medipt.transforms.spatial.flipping_transform"]], "medipt.transforms.spatial.random_affine_transform": [[5, "module-medipt.transforms.spatial.random_affine_transform"]], "medipt.transforms.spatial.rotation_transform": [[5, "module-medipt.transforms.spatial.rotation_transform"]], "medipt.transforms.spatial.scaling_transform": [[5, "module-medipt.transforms.spatial.scaling_transform"]], "medipt.transforms.spatial.spatial_transform": [[5, "module-medipt.transforms.spatial.spatial_transform"]], "medipt.transforms.spatial.spatial_transform_init": [[5, "module-medipt.transforms.spatial.spatial_transform_init"]], "medipt.transforms.spatial.translation_transform": [[5, "module-medipt.transforms.spatial.translation_transform"]], "random_bbox_translation() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_bbox_translation"]], "random_coord_translation() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_coord_translation"]], "random_elastic_deformation_input_image() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_elastic_deformation_input_image"]], "random_elastic_deformation_output_image() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_elastic_deformation_output_image"]], "random_elastic_deformation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_elastic_deformation_transform"]], "random_flipping_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_flipping_transform"]], "random_rotation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_rotation_transform"]], "random_scaling_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_scaling_transform"]], "random_translation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_translation_transform"]], "random_uniform_scaling_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.random_uniform_scaling_transform"]], "rotation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.rotation_transform"]], "scaling_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.scaling_transform"]], "translate_input_center_to_input_origin() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.translate_input_center_to_input_origin"]], "translate_input_center_to_output_center() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.translate_input_center_to_output_center"]], "translate_input_origin_to_output_center() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.translate_input_origin_to_output_center"]], "translate_random_input_center_to_input_origin() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.translate_random_input_center_to_input_origin"]], "translation_transform() (medipt.transforms.spatial.spatial_transform_init.spatialtransforminit method)": [[5, "medipt.transforms.spatial.spatial_transform_init.SpatialTransformInit.translation_transform"]], "get_output_size_from_spacing() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.get_output_size_from_spacing"]], "get_output_spacing_from_size() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.get_output_spacing_from_size"]], "image_center() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.image_center"]], "image_index_to_phys() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.image_index_to_phys"]], "initialize_rand_state() (in module medipt.utils.random_float)": [[7, "medipt.utils.random_float.initialize_rand_state"]], "medipt.utils": [[7, "module-medipt.utils"]], "medipt.utils.image_input_output_space": [[7, "module-medipt.utils.image_input_output_space"]], "medipt.utils.random_float": [[7, "module-medipt.utils.random_float"]], "medipt.utils.spatial_utils": [[7, "module-medipt.utils.spatial_utils"]], "physical_image_size() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.physical_image_size"]], "physical_image_size_no_origin() (in module medipt.utils.spatial_utils)": [[7, "medipt.utils.spatial_utils.physical_image_size_no_origin"]], "random_binomial() (in module medipt.utils.random_float)": [[7, "medipt.utils.random_float.random_binomial"]], "random_uniform_float() (in module medipt.utils.random_float)": [[7, "medipt.utils.random_float.random_uniform_float"]], "resolve_input_output_space() (in module medipt.utils.image_input_output_space)": [[7, "medipt.utils.image_input_output_space.resolve_input_output_space"]], "set_num_workers() (in module medipt.utils)": [[7, "medipt.utils.set_num_workers"]]}}) \ No newline at end of file