def from_proj(proj_from, proj_to, skip_equivalent=False, always_xy=False):
"""Make a Transformer from a :obj:`~pyproj.proj.Proj` or input used to create one.
Parameters
----------
proj_from: :obj:`~pyproj.proj.Proj` or input used to create one
Projection of input data.
proj_to: :obj:`~pyproj.proj.Proj` or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
always_xy: bool, optional
If true, the transform method will accept as input and return as output
coordinates using the traditional GIS order, that is longitude, latitude
for geographic CRS and easting, northing for most projected CRS.
Default is false.
Returns
-------
:obj:`~Transformer`
"""
if not isinstance(proj_from, Proj):
proj_from = Proj(proj_from)
if not isinstance(proj_to, Proj):
proj_to = Proj(proj_to)
return Transformer(
_Transformer.from_crs(
proj_from.crs,
proj_to.crs,
skip_equivalent=skip_equivalent,
always_xy=always_xy,
))
def from_crs(crs_from, crs_to, skip_equivalent=False):
"""Make a Transformer from a :obj:`~pyproj.crs.CRS` or input used to create one.
Parameters
----------
crs_from: ~pyproj.crs.CRS or input used to create one
Projection of input data.
crs_to: ~pyproj.crs.CRS or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
Returns
-------
:obj:`~Transformer`
"""
transformer = Transformer()
transformer._transformer = _Transformer.from_crs(
CRS.from_user_input(crs_from),
CRS.from_user_input(crs_to),
skip_equivalent=skip_equivalent,
)
return transformer
def from_crs(crs_from, crs_to, skip_equivalent=False, always_xy=False):
"""Make a Transformer from a :obj:`~pyproj.crs.CRS` or input used to create one.
Parameters
----------
crs_from: ~pyproj.crs.CRS or input used to create one
Projection of input data.
crs_to: ~pyproj.crs.CRS or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
always_xy: bool, optional
If true, the transform method will accept as input and return as output
coordinates using the traditional GIS order, that is longitude, latitude
for geographic CRS and easting, northing for most projected CRS.
Default is false.
Returns
-------
:obj:`~Transformer`
"""
transformer = Transformer(
_Transformer.from_crs(
CRS.from_user_input(crs_from),
CRS.from_user_input(crs_to),
skip_equivalent=skip_equivalent,
always_xy=always_xy,
))
return transformer
def from_proj(proj_from, proj_to, skip_equivalent=False):
"""Make a Transformer from a :obj:`~pyproj.proj.Proj` or input used to create one.
Parameters
----------
proj_from: :obj:`~pyproj.proj.Proj` or input used to create one
Projection of input data.
proj_to: :obj:`~pyproj.proj.Proj` or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
Returns
-------
:obj:`~Transformer`
"""
if not isinstance(proj_from, Proj):
proj_from = Proj(proj_from)
if not isinstance(proj_to, Proj):
proj_to = Proj(proj_to)
transformer = Transformer()
transformer._transformer = _Transformer.from_crs(
proj_from.crs, proj_to.crs, skip_equivalent=skip_equivalent)
return transformer
def from_crs(
crs_from: Any,
crs_to: Any,
skip_equivalent: bool = False,
always_xy: bool = False,
area_of_interest: Optional[AreaOfInterest] = None,
network: Optional[bool] = None,
) -> "Transformer":
"""Make a Transformer from a :obj:`pyproj.crs.CRS` or input used to create one.
.. versionadded:: 2.1.2 skip_equivalent
.. versionadded:: 2.2.0 always_xy
.. versionadded:: 2.3.0 area_of_interest
.. versionadded:: 3.0.0 network
Parameters
----------
crs_from: pyproj.crs.CRS or input used to create one
Projection of input data.
crs_to: pyproj.crs.CRS or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
always_xy: bool, optional
If true, the transform method will accept as input and return as output
coordinates using the traditional GIS order, that is longitude, latitude
for geographic CRS and easting, northing for most projected CRS.
Default is false.
area_of_interest: :class:`pyproj.transformer.AreaOfInterest`, optional
The area of interest to help select the transformation.
network: bool, optional
Default is None, which uses the system defaults for networking.
If True, it will force the use of network for grids regardless of
any other network setting. If False, it will force disable use of
network for grids regardless of any other network setting.
Returns
-------
Transformer
"""
return Transformer(
_Transformer.from_crs(
CRS.from_user_input(crs_from),
CRS.from_user_input(crs_to),
skip_equivalent=skip_equivalent,
always_xy=always_xy,
area_of_interest=area_of_interest,
network=network,
))
def __call__(self) -> _Transformer:
"""
Returns
-------
_Transformer
"""
return _Transformer.from_crs(
self.crs_from,
self.crs_to,
always_xy=self.always_xy,
area_of_interest=self.area_of_interest,
authority=self.authority,
accuracy=self.accuracy,
allow_ballpark=self.allow_ballpark,
)
def from_crs(crs_from, crs_to):
"""Make a Transformer from a :obj:`pyproj.CRS` or input used to create one.
Parameters
----------
proj_from: :obj:`pyproj.CRS` or input used to create one
Projection of input data.
proj_from: :obj:`pyproj.CRS` or input used to create one
Projection of output data.
Returns
-------
:obj:`pyproj.Transformer`
"""
transformer = Transformer()
transformer._transformer = _Transformer.from_crs(crs_from, crs_to)
return transformer
def from_crs(
crs_from: Any,
crs_to: Any,
skip_equivalent: bool = False,
always_xy: bool = False,
area_of_interest: Optional[AreaOfInterest] = None,
) -> "Transformer":
"""Make a Transformer from a :obj:`pyproj.crs.CRS` or input used to create one.
.. versionadded:: 2.1.2 skip_equivalent
.. versionadded:: 2.2.0 always_xy
.. versionadded:: 2.3.0 area_of_interest
Parameters
----------
crs_from: pyproj.crs.CRS or input used to create one
Projection of input data.
crs_to: pyproj.crs.CRS or input used to create one
Projection of output data.
skip_equivalent: bool, optional
If true, will skip the transformation operation if input and output
projections are equivalent. Default is false.
always_xy: bool, optional
If true, the transform method will accept as input and return as output
coordinates using the traditional GIS order, that is longitude, latitude
for geographic CRS and easting, northing for most projected CRS.
Default is false.
area_of_interest: :class:`pyproj.transformer.AreaOfInterest`, optional
The area of interest to help select the transformation.
Returns
-------
Transformer
"""
return Transformer(
_Transformer.from_crs(
CRS.from_user_input(crs_from)._crs,
CRS.from_user_input(crs_to)._crs,
skip_equivalent=skip_equivalent,
always_xy=always_xy,
area_of_interest=area_of_interest,
)
)
