itasca.template.Template Class Methods
-
class
itasca.template.
Template
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
dipdirmax
() → float.Get the template maximum dip direction in degrees.
dipdirmin
() → float.Get the template minimum dip direction in degrees.
dipmax
() → float.Get the template maximum dip in degrees.
dipmin
() → float.Get the template minimum dip in degrees.
id
() → int.Get the template id.
name
() → string.Get the template name.
norientparam
() → int.Get the template number of orientation parameters.
nposparam
() → int.Get the template number of position parameters.
nsizeparam
() → int.Get the template number of size parameters.
orientparam
(index) → string or float.Get a orientation parameter. The number of parameters can be assessed with the norientparam method.
orienttype
() → string.Get the template orientation type name. Acceptable values are uniform, gauss, powerlaw, bootstrapped, fish, fisher (3D only) and dips (3D only).
posparam
(index) → string or float.Get a position parameter. The number of parameters can be assessed with the nposparam method.
postype
() → string.Get the template orientation type name. Acceptable values are uniform, gauss, bootstrapped and fish.
set_dipdirmax
(value: float) → None.Set the template maximum dip direction in degrees.
set_dipdirmin
(value: float) → None.Set the template minimum dip direction in degrees.
set_dipmax
(value: float) → None.Set the template maximum dip in degrees.
set_dipmin
(value: float) → None.Set the template minimum dip in degrees.
set_orientparam
(index, parameter) → None.Set an orientation parameter. The parameter can be either a string or a float depending on the parameter. The number of parameters can be assessed with the norientparam method.
set_orienttype
(value: string) → None.Set the template orientation type name. Acceptable values are uniform, gauss, powerlaw, bootstrapped, fish, fisher (3D only) and dips (3D only).
set_posparam
(index, parameter) → None.Set a position parameter. The parameter can be either a string or a float depending on the parameter. The number of parameters can be assessed with the nposparam method.
set_postype
(value: string) → None.Set the template orientation type name. Acceptable values are uniform, gauss, bootstrapped and fish.
set_sizemax
(value: float) → None.Set the template maximum size. The fracture size is defined as the {fracture length in 2D; disk diameter in 3D}.
set_sizemin
(value: float) → None.Set the template minimum size. The fracture size is defined as the {fracture length in 2D; disk diameter in 3D}.
set_sizeparam
(index, parameter) → None.Set a size parameter. The parameter can be either a string or a float depending on the parameter. The number of parameters can be assessed with the nposparam method.
set_sizetype
(value: string) → None.Set the template size type name. Acceptable values are uniform, gauss, powerlaw, bootstrapped and fish.
sizemax
() → float.Get the template maximum size. The fracture size is defined as the {fracture length in 2D; disk diameter in 3D}.
sizemin
() → float.Get the template minimum size. The fracture size is defined as the {fracture length in 2D; disk diameter in 3D}.
sizeparam
(index) → string or float.Get a size parameter. The number of parameters can be assessed with the nsizeparam method.
sizetype
() → string.Get the template size type name. Acceptable values are uniform, gauss, powerlaw, bootstrapped and fish.
Was this helpful? ... | PFC 6.0 © 2019, Itasca | Updated: Nov 19, 2021 |