revanalyzer.metrics.permeability.Permeability

class revanalyzer.metrics.permeability.Permeability(direction='all', n_threads=1, resolution=1.0, show_time=False)

Bases: BasicMetric

Class describing permeability metric.

Input:

direction (str): ‘x’, ‘y’, ‘z’ or ‘all’. If label of this parameter is ‘all’, permeability values are generated for all 3 possible flow directions;

n_threads (int): number of threads used by FDMSS, default: 1;

resolution (float): resolution of studied sample (micrometers), default: 1;

show_time (bool): Added to monitor time cost for large images, default: False.

Methods

generate	Generates permeability for a specific subsample.
read	Read the metric data generated for a specific subsample.

generate(cut, cut_name, outputdir, gendatadir)

Generates permeability for a specific subsample.

Input:

cut (numpy.ndarray): 3D array representing a subsample;

cut_name (str): name of subsample;

outputdir (str): output folder;

gendatadir (str): folder with generated fdmss data output.

read(inputdir, step, cut_id)

Read the metric data generated for a specific subsample.

Input:

inputdir (str): path to the folder containing image;

step (int): subsamples selection step;

cut_id (int: 0,..8): cut index.

Output:

metric value (float or np.array(dtype=’float’)).