# obspy.clients.fdsn.mass_downloader.domain.Domain

class `Domain`

  Bases: `builtins.object`

  Abstract base class defining a domain - subclass it to define a new domain.

  Each subclass must implement the `get_query_parameters()` method and optionally the `is_in_domain()` method which enables the construction of arbitrarily complex domains. The `get_query_parameters()` method must return the query parameters to download as much data as required. The `is_in_domain()` can later be used to refine the domain after the data has been downloaded.

  It can be thought of as a boolean operation - first the rough domain is specified including all the possible points, then some points are removed again. This is illustrated with an example domain representing Germany utilizing the external packages shapely and fiona. Shapefiles can be found online on many websites, for example on http://www.gadm.org/. The example works by first extracting the bounds of the country to formulate the FDSN query and then removing points outside of the exact shape.

      import fiona
      import shapely.geometry

      from obspy.clients.fdsn.mass_downloader import Domain

      class Germany(Domain):
          def __init__(self):
              Domain.__init__(self)

              fiona_collection = fiona.open("./DEU_adm/DEU_adm0.shp")
              geometry = fiona_collection.next()["geometry"]

              self.shape = shapely.geometry.asShape(geometry)
              self.b = fiona_collection.bounds

          def get_query_parameters(self):
              return {"minlatitude": self.b[1],
                      "minlongitude": self.b[0],
                      "maxlatitude": self.b[3],
                      "maxlongitude": self.b[2]}

          def is_in_domain(self, latitude, longitude):
              if self.shape.contains(shapely.geometry.Point(longitude,
                                                            latitude)):
                  return True
              return False

  This is further illustrated by the following image. The green rectangle denotes the original FDSN query which returns the blue points. In the second step the red points are discarded leaving only points (stations) within Germany.

  Attributes

  `__abstractmethods__` | frozenset() -> empty frozenset object
  `__dict__` |
  `__doc__` | str(object=’‘) -> str
  `__module__` | str(object=’‘) -> str
  `__weakref__` | list of weak references to the object (if defined)

  Public Methods

  `get_query_parameters` | Return the domain specific query parameters for the
  `is_in_domain` | Returns True/False depending on the point being in the domain.

  Special Methods

  `__dir__` | default dir() implementation
  `__format__` | default object formatter
  `__new__` | Create and return a new object.
  `__reduce__` | helper for pickle
  `__reduce_ex__` | helper for pickle
  `__sizeof__` | size of object in memory, in bytes
  `__subclasshook__` | Abstract classes can override this to customize issubclass().

### Thank you!

We would like to thank our contributors, whose efforts make this software what it is. These people have helped by writing code and documentation, and by testing. They have created and maintained this product, its associated libraries and applications, our build tools and our web sites.

#### Contributors

- Ackerley, Nick
- Allgeyer, Sebastien
- Ammon, Charles J.
- Antunes, Emanuel
- Arnarsson, Ólafur St.
- Bank, Markus
- Barsch, Robert
- Behr, Yannik
- Bernardi, Fabrizio
- Bernauer, Felix
- Bes de Berc, Maxime
- Beyreuther, Moritz
- Boltz, Shawn
- Bonaimé, Sébastien
- Carothers, Lloyd
- Chamberlain, Calum
- Chambers, Derrick
- Chen, Zhao
- Clark, Adam
- Danecek, Peter
- Egdorf, Sven
- Engels, Fabian
- Ermert, Laura
- Eulenfeld, Tom

- Fabbri, Tommaso
- Falco, Nicholas
- Fee, Jeremy
- Grellier, Clément
- Grunberg, Marc
- Hammer, Conny
- Heimann, Sebastian
- Heiniger, Lukas
- Hope, Gaute
- Igel, Heiner
- Inza, Adolfo
- Isken, Marius
- Ketchum, David
- Koymans, Mathijs
- Kremers, Simon
- Kress, Victor
- Krieger, Lars
- Krischer, Lion
- Kula, Damian
- Käufl, Paul
- Köhler, Andreas
- Lecocq, Thomas
- Leeman, John
- Legovini, Paride

- Lesage, Philippe
- Li, Yulin
- Lomax, Anthony
- Lopes, Rui L.
- MacCarthy, Jonathan
- Maggi, Alessia
- Martin, Henri
- Medlin, Andrew
- Megies, Tobias
- Meschede, Matthias
- Michelini, Alberto
- Miller, Nathaniel C.
- Morgenstern, Bernhard
- Nof, Ran Novitsky
- Panning, Mark P.
- Parker, Tom
- Pestourie, Romain
- Rapagnani, Giovanni
- Reyes, Celso
- Ringler, Adam
- Rothenhäusler, Nicolas
- Russo, Emiliano
- Sales de Andrade, Elliott

- Satriano, Claudio
- Saul, Joachim
- Scheingraber, Chris
- Schneider, Simon
- Sippl, Christian
- Snoke, Arthur
- Stange, Stefan
- Stähler, Simon C.
- Sullivan, Benjamin
- Tian, Dongdong
- Trabant, Chad
- Trani, Luca
- Uieda, Leonardo
- Walker, Andrew
- Walther, Marcus
- Wassermann, Joachim
- Williams, Mark C.
- Winkelman, Andrew
- Zaccarelli, Riccardo
- Zad, Seyed Kasra Hosseini
- Zhu, Lijun
- van Driel, Martin
- van Wijk, Kasper

#### Funds

ObsPy was partially funded by the

- German Science Foundation (DFG) via grant DFG IG 16/9-1
- German Ministry for Education and Research (BMBF), GEOTECHNOLOGIEN grant 03G0646H.
- NERA project (Network of European Research Infrastructures for Earthquake Risk Assessment and Mitigation) under the European Community's Seventh Framework Programme (FP7/2007-2013) grant agreement n° 262330
- Leibniz Institute for Applied Geophysics (LIAG)
- VERCE EU-FP7 project (no. 283543)