LV_Speckles#

class project_heart.lv.modules.lv_speckles.LV_Speckles(enums={}, *args, **kwargs)#

_summary_

create_speckles(name=None, group=None, collection=None, d=3.0, from_nodeset=None, exclude_nodeset=None, perpendicular_to=None, normal_to=None, k=1.0, kmin=0.05, kmax=0.95, n_subsets=0, subsets_criteria='z', subsets_names=[], t=0.0, include_elmask=False, _use_long_line=False, n_clusters=None, cluster_criteria=None, log_level=30, ignore_unmatch_number_of_clusters=True, extrapolate_k=False, **kwargs)#

Creates Speckles

Parameters

  • name (_type_, optional) – _description_. Defaults to None.

  • group (_type_, optional) – _description_. Defaults to None.

  • collection (_type_, optional) – _description_. Defaults to None.

  • d (float, optional) – _description_. Defaults to 3.0.

  • from_nodeset (_type_, optional) – _description_. Defaults to None.

  • perpendicular_to (_type_, optional) – _description_. Defaults to None.

  • normal_to (_type_, optional) – _description_. Defaults to None.

  • k (float, optional) – _description_. Defaults to 1.0.

  • kmin (float, optional) – _description_. Defaults to 0.1.

  • kmax (float, optional) – _description_. Defaults to 0.95.

  • n_subsets (int, optional) – _description_. Defaults to 0.

  • subsets_criteria (str, optional) – _description_. Defaults to “z”.

  • subsets_names (list, optional) – _description_. Defaults to [].

  • t (float, optional) – _description_. Defaults to 0.0.

  • include_elmask (bool, optional) – _description_. Defaults to False.

  • _use_long_line (bool, optional) – _description_. Defaults to False.

  • log_level (_type_, optional) – _description_. Defaults to logging.WARNING.

Raises

  • RuntimeError – _description_

  • ValueError – _description_

Returns

_description_

Return type

_type_

get_speckles(**kwargs)#

Returns a specified datatype of speckles