locan.data.register.register_cc#
- locan.data.register.register_cc(locdata, other_locdata, bins=None, n_bins=None, bin_size=None, bin_edges=None, bin_range=None, **kwargs)[source]#
Register points or coordinates in locdata by a cross-correlation algorithm.
- Parameters:
locdata (
Union
[_SupportsArray
[dtype
[Any
]],_NestedSequence
[_SupportsArray
[dtype
[Any
]]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]],LocData
]) – Localization data representing the source on which to perform the manipulation.other_locdata (
Union
[_SupportsArray
[dtype
[Any
]],_NestedSequence
[_SupportsArray
[dtype
[Any
]]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]],LocData
]) – Localization data representing the target.bins (
UnionType
[Bins
,Axis
,AxesTuple
,None
]) – Specific class specifying the bins.bin_edges (
UnionType
[Sequence
[float
],Sequence
[Sequence
[float
]],None
]) – Bin edges for all or each dimension with shape (dimension, n_bin_edges).bin_range (
Union
[tuple
[float
,float
],Sequence
[float
],Sequence
[Sequence
[float
]],Literal
['zero'
,'link'
],None
]) – Minimum and maximum edge for all or each dimensions with shape (2,) or (dimension, 2). If None (min, max) ranges are determined from data and returned; if ‘zero’ (0, max) ranges with max determined from data are returned. if ‘link’ (min_all, max_all) ranges with min and max determined from all combined data are returned.n_bins (
UnionType
[int
,Sequence
[int
],None
]) – The number of bins for all or each dimension. 5 yields 5 bins in all dimensions. (2, 5) yields 2 bins for one dimension and 5 for the other dimension.bin_size (
UnionType
[float
,Sequence
[float
],Sequence
[Sequence
[float
]],None
]) – The size of bins for all or each bin and for all or each dimension with shape (dimension,) or (dimension, n_bins). 5 would describe bin_size of 5 for all bins in all dimensions. ((2, 5),) yield bins of size (2, 5) for one dimension. (2, 5) yields bins of size 2 for one dimension and 5 for the other dimension. ((2, 5), (1, 3)) yields bins of size (2, 5) for one dimension and (1, 3) for the other dimension. To specify arbitrary sequence of bin_size use bin_edges instead.kwargs (
Any
) – Other parameters passed toskimage.phase_cross_correlation()
.
- Returns:
Matrix and offset representing the optimized transformation.
- Return type: