B
    ]t\0                 @   s,   d Z ddlZddlmZ G dd deZdS )z
Tools for triangular grids.
    N)Triangulationc               @   sP   e Zd ZdZdd Zedd ZdddZdd
dZdddZ	e
dddZdS )TriAnalyzera  
    Define basic tools for triangular mesh analysis and improvement.

    A TriAnalizer encapsulates a :class:`~matplotlib.tri.Triangulation`
    object and provides basic tools for mesh analysis and mesh improvement.

    Parameters
    ----------
    triangulation : :class:`~matplotlib.tri.Triangulation` object
        The encapsulated triangulation to analyze.

    Attributes
    ----------
    `scale_factors`

    c             C   s   t |tstd|| _d S )NzExpected a Triangulation object)
isinstancer   
ValueError_triangulation)selfZtriangulation r   6lib/python3.7/site-packages/matplotlib/tri/tritools.py__init__   s    
zTriAnalyzer.__init__c             C   sT   | j  }tjt|| j jjddk}dt| j j|  dt| j j|  fS )ar  
        Factors to rescale the triangulation into a unit square.

        Returns *k*, tuple of 2 scale factors.

        Returns
        -------
        k : tuple of 2 floats (kx, ky)
            Tuple of floats that would rescale the triangulation :
            ``[triangulation.x * kx, triangulation.y * ky]``
            fits exactly inside a unit square.

        )	minlengthr      )	r   get_masked_trianglesnpbincountravelxsizeZptpy)r   compressed_trianglesZ	node_usedr   r   r	   scale_factors    s
    
zTriAnalyzer.scale_factorsTc             C   sX  |r| j \}}nd\}}t| jj| | jj| gj}|| jj }|dddddf |dddddf  }|dddddf |dddddf  }|dddddf |dddddf  }t|dddf d |dddf d  }t|dddf d |dddf d  }t|dddf d |dddf d  }|| | d }	|	|| |	  || |	  || |	  }
|
dk}t	|r|j
d }tj|tjd}tj||< || | }||  d	t|
|    || < n|| | d	t|
  }|| | d	| |	  }|| }| jj}|dkrD|S tjj||d
S dS )a  
        Returns a measure of the triangulation triangles flatness.

        The ratio of the incircle radius over the circumcircle radius is a
        widely used indicator of a triangle flatness.
        It is always ``<= 0.5`` and ``== 0.5`` only for equilateral
        triangles. Circle ratios below 0.01 denote very flat triangles.

        To avoid unduly low values due to a difference of scale between the 2
        axis, the triangular mesh can first be rescaled to fit inside a unit
        square with :attr:`scale_factors` (Only if *rescale* is True, which is
        its default value).

        Parameters
        ----------
        rescale : boolean, optional
            If True, a rescaling will be internally performed (based on
            :attr:`scale_factors`, so that the (unmasked) triangles fit
            exactly inside a unit square mesh. Default is True.

        Returns
        -------
        circle_ratios : masked array
            Ratio of the incircle radius over the
            circumcircle radius, for each 'rescaled' triangle of the
            encapsulated triangulation.
            Values corresponding to masked triangles are masked out.

        )g      ?g      ?Nr   r      g      ?g        )dtypeg      @)mask)r   r   Zvstackr   r   r   T	trianglesZsqrtanyshapeemptyZfloat64infr   maZarray)r   rescaleZkxZkyZptsZtri_ptsabcsZprodZ	bool_flatntriZcircum_radiusabcZ	in_radiusZcircle_ratior   r   r   r	   circle_ratios5   s:    ,,,...(


zTriAnalyzer.circle_ratios{Gz?c             C   s   | j jjd }| ||k }| j j}|dkr:tj|td}t| j j	}tj
|tjd}d}xp|dkrtj|dddk| @ }	t|	|}
|
|B }t|
}d||
ddf< d||
< t|dkd|| }q^W tj|dS )a  
        Eliminates excessively flat border triangles from the triangulation.

        Returns a mask *new_mask* which allows to clean the encapsulated
        triangulation from its border-located flat triangles
        (according to their :meth:`circle_ratios`).
        This mask is meant to be subsequently applied to the triangulation
        using :func:`matplotlib.tri.Triangulation.set_mask`.
        *new_mask* is an extension of the initial triangulation mask
        in the sense that an initially masked triangle will remain masked.

        The *new_mask* array is computed recursively; at each step flat
        triangles are removed only if they share a side with the current mesh
        border. Thus no new holes in the triangulated domain will be created.

        Parameters
        ----------
        min_circle_ratio : float, optional
            Border triangles with incircle/circumcircle radii ratio r/R will
            be removed if r/R < *min_circle_ratio*. Default value: 0.01
        rescale : boolean, optional
            If True, a rescaling will first be internally performed (based on
            :attr:`scale_factors` ), so that the (unmasked) triangles fit
            exactly inside a unit square mesh. This rescaling accounts for the
            difference of scale which might exist between the 2 axis. Default
            (and recommended) value is True.

        Returns
        -------
        new_mask : array-like of booleans
            Mask to apply to encapsulated triangulation.
            All the initially masked triangles remain masked in the
            *new_mask*.

        Notes
        -----
        The rationale behind this function is that a Delaunay
        triangulation - of an unstructured set of points - sometimes contains
        almost flat triangles at its border, leading to artifacts in plots
        (especially for high-resolution contouring).
        Masked with computed *new_mask*, the encapsulated
        triangulation would contain no more unmasked border triangles
        with a circle ratio below *min_circle_ratio*, thus improving the
        mesh quality for subsequent plots or interpolation.
        r   N)r   r   )axisT)r   r   r   r'   r   r   ZzerosboolcopyZ	neighborsarangeint32minZlogical_andsumwherer   Zfilled)r   Zmin_circle_ratior    r%   Zmask_bad_ratioZcurrent_maskZvalid_neighborsZrenum_neighborsZnaddZ	wavefrontZ
added_maskr   r   r	   get_flat_tri_maskz   s&    1

zTriAnalyzer.get_flat_tri_maskFc             C   s   | j j}| j  }| j jjd }| ||}tjt|| j j	j
ddk}| j j	|  }| j j|  }	| |}
|
| }|s|s|||	fS |||	|
fS n|s|||	|fS |||	||
fS dS )a8  
        Compress (if masked) the encapsulated triangulation.

        Returns minimal-length triangles array (*compressed_triangles*) and
        coordinates arrays (*compressed_x*, *compressed_y*) that can still
        describe the unmasked triangles of the encapsulated triangulation.

        Parameters
        ----------
        return_tri_renum : boolean, optional
            Indicates whether a renumbering table to translate the triangle
            numbers from the encapsulated triangulation numbering into the
            new (compressed) renumbering will be returned.
        return_node_renum : boolean, optional
            Indicates whether a renumbering table to translate the nodes
            numbers from the encapsulated triangulation numbering into the
            new (compressed) renumbering will be returned.

        Returns
        -------
        compressed_triangles : array-like
            the returned compressed triangulation triangles
        compressed_x : array-like
            the returned compressed triangulation 1st coordinate
        compressed_y : array-like
            the returned compressed triangulation 2nd coordinate
        tri_renum : array-like of integers
            renumbering table to translate the triangle numbers from the
            encapsulated triangulation into the new (compressed) renumbering.
            -1 for masked triangles (deleted from *compressed_triangles*).
            Returned only if *return_tri_renum* is True.
        node_renum : array-like of integers
            renumbering table to translate the point numbers from the
            encapsulated triangulation into the new (compressed) renumbering.
            -1 for unused points (i.e. those deleted from *compressed_x* and
            *compressed_y*). Returned only if *return_node_renum* is True.

        r   )r   N)r   r   r   r   r   _total_to_compress_renumr   r   r   r   r   r   )r   Zreturn_tri_renumZreturn_node_renumZtri_maskr   r%   Z	tri_renumZ	node_maskZcompressed_xZcompressed_yZ
node_renumr   r   r	   _get_compressed_triangulation   s(    )


z)TriAnalyzer._get_compressed_triangulationNc             C   s|   |dkrt | }| dk	rht j|t jd }t j|t jdj|  dd}t jt |dt jd||< |S t j|t jdS dS )aT  
        Parameters
        ----------
        mask : 1d boolean array or None
            mask
        n : integer
            length of the mask. Useful only id mask can be None

        Returns
        -------
        renum : integer array
            array so that (`valid_array` being a compressed array
            based on a `masked_array` with mask *mask*) :

                  - For all i such as mask[i] = False:
                    valid_array[renum[i]] = masked_array[i]
                  - For all i such as mask[i] = True:
                    renum[i] = -1 (invalid value)

        N)r   r   )r*   )r   r   Zonesr.   r-   compress)r   nZrenumZvalidr   r   r	   r3     s    
z$TriAnalyzer._total_to_compress_renum)T)r(   T)FF)N)__name__
__module____qualname____doc__r
   propertyr   r'   r2   r4   staticmethodr3   r   r   r   r	   r   
   s   
E
M 
Fr   )r:   Znumpyr   Zmatplotlib.trir   objectr   r   r   r   r	   <module>   s   