Package fr.ign.artiscales.pm.analysis

Class RealUrbanFabricParameters

java.lang.Object
fr.ign.artiscales.pm.analysis.RealUrbanFabricParameters
public class RealUrbanFabricParameters extends Object
This class generates values for the description of a parcel layout. It is aimed to help the setting of ProfileUrbanFabric parameters. It can work on different scales, from the block or the zonePreciseNameField of a zoning plan to a whole community. A zone scale must be defined

  • Constructor Summary

    Constructors
    Constructor
    Description
    RealUrbanFabricParameters​(String scaleZone, File root)
    Constructor for a basic file organization.
    RealUrbanFabricParameters​(String scaleZone, File parcelFile, File buildingFile, File zoningFile, File roadFile, File outFolder)
    Constructor for a complete analysis.
    RealUrbanFabricParameters​(org.geotools.data.simple.SimpleFeatureCollection parcelSFC, File buildingFile)
    Constructor for a short usage (only input parcel's area).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generateEveryAnalysisOfScene()
    Generate every indicators about the urban scene (area of parcel built and area of all parcels, road statistics)
    org.apache.commons.math3.stat.descriptive.DescriptiveStatistics
    getAreaBuilt()
    Get area built for a short usage.
    org.apache.commons.math3.stat.descriptive.DescriptiveStatistics
    getAreaBuilt​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName)
    Get the distribution of built parcel's area of one zone.
    org.apache.commons.math3.stat.descriptive.DescriptiveStatistics
    getAreaTotal​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName)
    Get the distribution of every parcel's area of one zone.
    String
    getScaleZone()
    Get the scale of the analyzed zone
    void
    makeAreaBuiltAndTotal​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName)
    Calculate the area bound of every parcels then only the build parcels.
    void
    makeSplitParcelBetweenZone()
    Fulfill the collection of zones by splitting the parcel plan relatively to the given scale type.
    void
    roadInformations​(org.geotools.data.simple.SimpleFeatureCollection zoneCollection, org.geotools.data.simple.SimpleFeatureCollection road, String scaleZone, String zoneName)
    Generate the road information in the give zones.
    void
    setFiles​(File mainFolder)
    Set automaticlally the file names with their basic names from a root folder.
    void
    setScaleZone​(String scaleZone)
    Set the scale of the analyzed zone.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RealUrbanFabricParameters

      public RealUrbanFabricParameters​(String scaleZone, File parcelFile, File buildingFile, File zoningFile, File roadFile, File outFolder)
      Constructor for a complete analysis.
      Parameters:
      scaleZone - scale of the analysis
      parcelFile - geoFile for parcel plan
      buildingFile - geoFile for buildings
      zoningFile - geoFile for zoning plan
      roadFile - geoFile for roads
      outFolder - folder where outputs are wrote

    • RealUrbanFabricParameters

      public RealUrbanFabricParameters​(String scaleZone, File root)
      Constructor for a basic file organization.
      Parameters:
      scaleZone - scale of the analysis
      root - root folder must contain geo files properly named

    • RealUrbanFabricParameters

      public RealUrbanFabricParameters​(org.geotools.data.simple.SimpleFeatureCollection parcelSFC, File buildingFile)
      Constructor for a short usage (only input parcel's area).
      Parameters:
      parcelSFC - set of parcels
      buildingFile - geoFile containing

  • Method Details

    • getScaleZone

      public String getScaleZone()
      Get the scale of the analyzed zone
      Returns:
      the scale

    • setScaleZone

      public void setScaleZone​(String scaleZone)
      Set the scale of the analyzed zone.
      Parameters:
      scaleZone - Can either be:
      • community
      • genericZone
      • preciseZone
      • block

    • setFiles

      public void setFiles​(File mainFolder)
      Set automaticlally the file names with their basic names from a root folder. Possible to change them with dedicaded setters
      Parameters:
      mainFolder - root folder containing the geographic layers.

    • generateEveryAnalysisOfScene

      public void generateEveryAnalysisOfScene() throws IOException
      Generate every indicators about the urban scene (area of parcel built and area of all parcels, road statistics)
      Throws:
      IOException - reading files

    • makeSplitParcelBetweenZone

      public void makeSplitParcelBetweenZone() throws IOException
      Fulfill the collection of zones by splitting the parcel plan relatively to the given scale type. Scale and the collection of zones per scale type's units are stored statically.
      Throws:
      IOException - reading files

    • roadInformations

      public void roadInformations​(org.geotools.data.simple.SimpleFeatureCollection zoneCollection, org.geotools.data.simple.SimpleFeatureCollection road, String scaleZone, String zoneName) throws IOException
      Generate the road information in the give zones.
      Parameters:
      zoneCollection - parcels from the zones to analyse
      road - road feature collection
      scaleZone - name of the scale to analyse
      zoneName - name of the zone to analyse
      Throws:
      IOException - reading files

    • getAreaBuilt

      public org.apache.commons.math3.stat.descriptive.DescriptiveStatistics getAreaBuilt() throws IOException
      Get area built for a short usage. A single zone has to be defined.
      Returns:
      the distribution of area.
      Throws:
      IOException - if wrong parcelPerZone Map is defined, or (potentially) reading geo files and writing csv

    • getAreaBuilt

      public org.apache.commons.math3.stat.descriptive.DescriptiveStatistics getAreaBuilt​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName) throws IOException
      Get the distribution of built parcel's area of one zone.
      Parameters:
      collection - parcel collection
      zoneName - name of the zone to get
      Returns:
      the distribution
      Throws:
      IOException - (potentially) reading geo files and writing csv

    • getAreaTotal

      public org.apache.commons.math3.stat.descriptive.DescriptiveStatistics getAreaTotal​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName) throws IOException
      Get the distribution of every parcel's area of one zone.
      Parameters:
      collection - parcel collection
      zoneName - name of the zone to get
      Returns:
      the distribution
      Throws:
      IOException - (potentially) reading geofiles and writting csv

    • makeAreaBuiltAndTotal

      public void makeAreaBuiltAndTotal​(org.geotools.data.simple.SimpleFeatureCollection collection, String zoneName) throws IOException
      Calculate the area bound of every parcels then only the build parcels.
      Parameters:
      collection - parcel collection
      zoneName - name of the zone to analyze
      Throws:
      IOException - reading geofiles and writting csv