TM1.6.1: Use updated data, etc.

core/cmf/common-base/src/java/com/pb/common/newmodel/ChoiceModelApplication.java

@@ -47,6 +47,14 @@ public class ChoiceModelApplication implements java.io.Serializable {
     private long totalCount;
     private long otherCount;
 
+	public ChoiceModelApplication (String controlFileName, int modelSheet, int dataSheet, HashMap<String,String> propertyMap, Object dmuClassObject, Logger logger) {
+        // call the original constructor
+        this(controlFileName, modelSheet, dataSheet, propertyMap, dmuClassObject);
+
+        if (logger != null) {
+            debugLogger = logger;
+        }
+    }
 
 	public ChoiceModelApplication (String controlFileName, int modelSheet, int dataSheet, HashMap<String,String> propertyMap, Object dmuObject) {
 
@@ -594,7 +602,7 @@ public void logLogitCalculations(String choiceModelLabel, String decisionMakerLa
     {
         debugLogger
                 .debug("****************************************************************************************************************");
-        debugLogger.debug(String.format("HH DEBUG:  %s Logit Calcuations for %s", choiceModelLabel,
+        debugLogger.debug(String.format("HH DEBUG:  %s Logit Calculations for %s", choiceModelLabel,
                 decisionMakerLabel));
         debugLogger
                 .debug("****************************************************************************************************************");
@@ -638,6 +646,10 @@ private void logLogitCalculations(LogitModel nest)
     		}
     	}
     }
+
+    public void logDataValues(Logger localLogger, int origTaz, int destTaz) {
+        uec.logDataValues(localLogger, origTaz, destTaz, 0);
+    }
 
     public void logUECResults ( Logger localLogger ){
         logUECResults( localLogger, description );

core/models/ctramp/src/java/com/pb/models/ctramp/CoordinatedDailyActivityPatternDMU.java

@@ -6,6 +6,7 @@
 import org.apache.log4j.Logger;
 
 import com.pb.common.calculator.IndexValues;
+import com.pb.common.calculator.MatrixDataManager;
 import com.pb.common.calculator.VariableTable;
 
 /**
@@ -32,27 +33,31 @@ public class CoordinatedDailyActivityPatternDMU implements Serializable, Variabl
     public CoordinatedDailyActivityPatternDMU(){
     	dmuIndex = new IndexValues();
     }
-
-    public void setPropertyFileValues( HashMap<String, String> propertyMap ) {
-        // pass
-    }
 
-    public void setDmuIndexValues(int zoneId) {
-        dmuIndex.setZoneIndex(zoneId);
+    public void setDmuIndexValues(int hhId, int homeTaz, int workTaz, Logger localLogger) {
+        setDmuIndexValues(hhId, homeTaz, workTaz);
+        if ( householdObject.getDebugChoiceModels() ) {
+            localLogger.info("CoordinatedDailyActivityPatternDMU.setDmuIndexValues(): " + dmuIndex.toString());
+        }
+    }
 
+    public void setDmuIndexValues(int hhId, int homeTaz, int workTaz) {
+        dmuIndex.setHHIndex(hhId);
+        dmuIndex.setOriginZone(homeTaz);
+        dmuIndex.setDestZone(workTaz);
         dmuIndex.setDebug(false);
-        dmuIndex.setDebugLabel ( "" );
+        dmuIndex.setDebugLabel("");
+
         if ( householdObject.getDebugChoiceModels() ) {
             dmuIndex.setDebug(true);
-            dmuIndex.setDebugLabel ( "Debug CDAP UEC" );
+            dmuIndex.setDebugLabel ("Debug CDAP UEC");
         }
-
     }
 
     public IndexValues getIndexValues() {
         return dmuIndex; 
     }
-    
+
     public void setHousehold(Household passedInHouseholdObject){
 
     	householdObject = passedInHouseholdObject;
@@ -71,9 +76,13 @@ public void setPersonA(Person passedInPersonA){
         dmuIndex.setStopZone(passedInPersonA.getPersonWorkLocationZone());
     }
 
-    public void setWorksFromHomeForPersonA(Logger cdapLogger) {
+    public void setIndustryForPersonA(Logger cdapLogger) {
         // pass -- implemented in subclass
     }
+    public IndexValues getDmuIndexValues() {
+        return dmuIndex;
+    }
+
 
     public void setPersonB(Person passedInPersonB){
     	this.personB = passedInPersonB;

core/models/ctramp/src/java/com/pb/models/ctramp/HouseholdDataWriter.java

@@ -401,6 +401,7 @@ private List<String> formPersonColumnNames() {
         data.add("schoolDCLogsum");
         data.add("sampleRate");
         data.add("wfh_choice");
+        data.add("industry");
         return data;
     }
 
@@ -421,6 +422,7 @@ private List<SqliteDataTypes> formPersonColumnTypes() {
         data.add(SqliteDataTypes.REAL); 
         data.add(SqliteDataTypes.REAL); 
         data.add(SqliteDataTypes.INTEGER);
+        data.add(SqliteDataTypes.TEXT);
         return data;
     }
 
@@ -442,6 +444,7 @@ private List<String> formPersonDataEntry(Person p) {
         float sampleRate = p.getSampleRate();
         data.add(string(sampleRate));
         data.add(string(p.getPersonWorksFromHome()));
+        data.add(p.getPersonIndustry());
         return data;
     }
 

core/models/ctramp/src/java/com/pb/models/ctramp/Person.java

@@ -36,6 +36,18 @@ public class Person implements java.io.Serializable {
     public static final String[] employmentCategoryNameArray = {EMPLOYMENT_CATEGORY_FULL_TIME_WORKER_NAME,
         EMPLOYMENT_CATEGORY_PART_TIME_WORKER_NAME,EMPLOYMENT_CATEGORY_NOT_EMPLOYED_NAME,EMPLOYMENT_CATEGORY_UNDER_AGE_16_NAME};
 
+    // six categories: https://github.com/BayAreaMetro/modeling-website/wiki/TazData
+    public static final String INDUSTRY_CATEGORY_NA                         = "N/A";
+    public static final String INDUSTRY_CATEGORY_AGREMP                     = "AGR";
+    public static final String INDUSTRY_CATEGORY_FPSEMP                     = "FPS";
+    public static final String INDUSTRY_CATEGORY_HEREMP                     = "HER";
+    public static final String INDUSTRY_CATEGORY_MWTEMP                     = "MWT";
+    public static final String INDUSTRY_CATEGORY_OTHEMP                     = "OTH";
+    public static final String INDUSTRY_CATEGORY_RETEMP                     = "RET";
+
+    public static final String[] industryCategoryNameArray = {INDUSTRY_CATEGORY_NA, INDUSTRY_CATEGORY_AGREMP, INDUSTRY_CATEGORY_FPSEMP,
+        INDUSTRY_CATEGORY_HEREMP, INDUSTRY_CATEGORY_MWTEMP, INDUSTRY_CATEGORY_OTHEMP, INDUSTRY_CATEGORY_RETEMP};
+
     public static final String WFH_CATEGORY_NA                              = "N/A";
     public static final String WFH_CATEGORY_GOES_TO_WORK                    = "Goes to work";
     public static final String WFH_WORKS_FROM_HOME                          = "Works from home";
@@ -56,6 +68,7 @@ public class Person implements java.io.Serializable {
     private byte persAge;
     private byte persGender;
     private byte persEmploymentCategory;
+    private byte persIndustryCategory;     // set by CoordinatedDailyActivityPatternModel
     private byte persWfhCategory;          // set by CoordinatedDailyActivityPatternModel
     private byte persStudentCategory;
     private byte personType;
@@ -323,8 +336,12 @@ public void setPersEmploymentCategory( int category ) {
         persEmploymentCategory = (byte)category;
     }
 
-    public void setPersWorksFromHomeCategory(int category) {
-        persWfhCategory = (byte)category;
+    public void setPersIndustryCategory(Person.IndustryStatus category) {
+        persIndustryCategory = (byte)category.ordinal();
+    }
+
+    public void setPersWorksFromHomeCategory(Person.WorkFromHomeStatus category) {
+        persWfhCategory = (byte)category.ordinal();
     }
 
     public void setPersStudentCategory( int category ){
@@ -888,6 +905,16 @@ public int getPersonWorksFromHome() {
         else
             return 0;
     }
+    /**
+     * Get assumed industry for person.
+     * @return 3-letter code for industry
+     */
+    public String getPersonIndustry() {
+        if (persIndustryCategory == IndustryStatus.nul.ordinal()) return "nul";
+        if (persIndustryCategory == IndustryStatus.NOT_APPLICABLE.ordinal()) return "N_A";
+        if (persIndustryCategory > industryCategoryNameArray.length) return "ERR";
+        return industryCategoryNameArray[persIndustryCategory-1];
+    }
     /**
      * Determine if person is a student (of any age, independent of person type)
      * @return 1 if student, 0 otherwise
@@ -1290,6 +1317,7 @@ public void logPersonObject( Logger logger, int totalChars ) {
         Household.logHelper( logger, "persAge: ", persAge, totalChars );
         Household.logHelper( logger, "persGender: ", persGender, totalChars );
         Household.logHelper( logger, "persEmploymentCategory: ", persEmploymentCategory, totalChars );
+        Household.logHelper( logger, "persIndustryCategory: ", persIndustryCategory, totalChars );
         Household.logHelper( logger, "persWfhCategory: ", persWfhCategory, totalChars );
         Household.logHelper( logger, "persStudentCategory: ", persStudentCategory, totalChars );
         Household.logHelper( logger, "personType: ", personType, totalChars );
@@ -1445,6 +1473,7 @@ public void logEntirePersonObject( Logger logger, ModelStructure modelStructure
         Household.logHelper( logger, "persAge: ", persAge, totalChars );
         Household.logHelper( logger, "persGender: ", persGender, totalChars );
         Household.logHelper( logger, "persEmploymentCategory: ", persEmploymentCategory, totalChars );
+        Household.logHelper( logger, "persIndustryCategory: ", persIndustryCategory, totalChars );
         Household.logHelper( logger, "persWfhCategory: ", persWfhCategory, totalChars );
         Household.logHelper( logger, "persStudentCategory: ", persStudentCategory, totalChars );
         Household.logHelper( logger, "personType: ", personType, totalChars );
@@ -1606,6 +1635,17 @@ public enum EmployStatus {
         UNDER16
     }
 
+    public enum IndustryStatus {
+        nul,            // unset
+        NOT_APPLICABLE, // non-worker
+        AGREMP,
+        FPSEMP,
+        HEREMP,
+        MWTEMP,
+        OTHEMP,
+        RETEMP
+    }
+
     public enum WorkFromHomeStatus {
         nul,             // unset
         NOT_APPLICABLE,  // non-worker

core/models/ctramp/src/java/com/pb/models/ctramp/jppf/HouseholdCoordinatedDailyActivityPatternModel.java

@@ -64,7 +64,9 @@ public class HouseholdCoordinatedDailyActivityPatternModel implements Serializab
     private static final String HOME_PATTERN         = Definitions.HOME_PATTERN;
     private static final String[] activityNameArray = { MANDATORY_PATTERN, NONMANDATORY_PATTERN, HOME_PATTERN };
 
-
+    // New for MTC TM1.6.1: WFH model
+    private static final int UEC_WORK_FROM_HOME = 5;
+
     private ModelStructure modelStructure;
     private double[][] fixedCumulativeProportions;
 
@@ -79,6 +81,8 @@ public class HouseholdCoordinatedDailyActivityPatternModel implements Serializab
 
     // Four separate UECs to compute segments of the utility
     private UtilityExpressionCalculator onePersonUec, twoPeopleUec, threePeopleUec, allMemberInteractionUec;
+    // WorkFromHome ChoiceModel Application
+    private ChoiceModelApplication workFromHomeChoiceModelApp;
 
 
     public HouseholdCoordinatedDailyActivityPatternModel( HashMap<String, String> propertyMap, ModelStructure modelStructure, CtrampDmuFactoryIf dmuFactory ) {
@@ -95,7 +99,7 @@ public HouseholdCoordinatedDailyActivityPatternModel( HashMap<String, String> pr
     private void setupCoordinatedDailyActivityPatternModelApplication( HashMap<String, String> propertyMap, CtrampDmuFactoryIf dmuFactory ) {
 
         logger.info( "setting up CDAP choice model." );
-        
+
         // locate the coordinated daily activity pattern choice model UEC
         String projectDirectory = propertyMap.get( CtrampApplication.PROPERTIES_PROJECT_DIRECTORY );
         String cdapUecFile = propertyMap.get( PROPERTIES_UEC_DAILY_ACTIVITY_PATTERN);
@@ -105,15 +109,16 @@ private void setupCoordinatedDailyActivityPatternModelApplication( HashMap<Strin
         // create the coordinated daily activity pattern choice model DMU object.
         logger.info( "About to create cdapDmuObject" );
         cdapDmuObject = dmuFactory.getCoordinatedDailyActivityPatternDMU();
-        cdapDmuObject.setPropertyFileValues(propertyMap);
         logger.info( "cdapDmuObject = " + cdapDmuObject );
 
         // create the uecs
         onePersonUec = new UtilityExpressionCalculator( new File(cdapUecFile), UEC_ONE_PERSON, UEC_DATA_PAGE, propertyMap, (VariableTable)cdapDmuObject );
         twoPeopleUec = new UtilityExpressionCalculator( new File(cdapUecFile), UEC_TWO_PERSON, UEC_DATA_PAGE, propertyMap, (VariableTable)cdapDmuObject );
         threePeopleUec = new UtilityExpressionCalculator( new File(cdapUecFile), UEC_THREE_PERSON, UEC_DATA_PAGE, propertyMap, (VariableTable)cdapDmuObject );
         allMemberInteractionUec = new UtilityExpressionCalculator( new File(cdapUecFile), UEC_ALL_PERSON, UEC_DATA_PAGE, propertyMap, (VariableTable)cdapDmuObject );
-
+
+        workFromHomeChoiceModelApp = new ChoiceModelApplication(cdapUecFile, UEC_WORK_FROM_HOME, UEC_DATA_PAGE, propertyMap, (Object )cdapDmuObject, cdapLogger);
+
         //get the proportions by person type
         double[][] fixedRelativeProportions = modelStructure.getCdap6PlusProps();
         fixedCumulativeProportions = new double[fixedRelativeProportions.length][];
@@ -311,7 +316,7 @@ private void createLogitModels(){
      * the activity pattern for that person, in order (see Household.reOrderPersonsForCdap method).
      */
     public String getCoordinatedDailyActivityPatternChoice( Household householdObject ){
-        
+
         // set all household level dmu variables
         cdapDmuObject.setHousehold(householdObject);
 
@@ -322,18 +327,59 @@ public String getCoordinatedDailyActivityPatternChoice( Household householdObjec
         // reorder persons for large households if need be
         reOrderPersonsForCdap(householdObject);
 
-        // loop through each person for WFH
-        for(int i=0;i<modelHhSize;++i){
-            Person personA = getCdapPerson(i+1);
+        // loop through each person for industry and WFH
+        for(int i=1;i<actualHhSize+1;++i){
+            Person personA = householdObject.getPersons()[i];
             // set the person level dmu variables
             cdapDmuObject.setPersonA(personA);
 
+            // make the simple person industry choice
+            cdapDmuObject.setDmuIndexValues(householdObject.getHhId(),
+                householdObject.getHhTaz(), personA.getPersonWorkLocationZone());
+            cdapDmuObject.setIndustryForPersonA(cdapLogger);
+
+            // if the person doesn't have an industry then don't continue
+            String personIndustry = personA.getPersonIndustry();
             if(householdObject.getDebugChoiceModels()){
-                cdapLogger.info("Household " + householdObject.getHhId() + " Person " + i + " => " + personA.getPersonId());
+                cdapLogger.info("Household " + householdObject.getHhId() + " Person " + i + 
+                    " => " + personA.getPersonId() + "; personIndustry=" + personIndustry);
+            }
+            if ((personIndustry == "nul") || (personIndustry == "N_A") || (personIndustry == "ERR")) {
+                continue;
+            }
+
+            // compute the wfh utilities
+            workFromHomeChoiceModelApp.computeUtilities( cdapDmuObject, cdapDmuObject.getDmuIndexValues());
+
+            // if the choice model has at least one available alternative, make choice.
+            int chosenAlt;
+            double randomNumber = householdObject.getHhRandom().nextDouble();
+            if (workFromHomeChoiceModelApp.getAvailabilityCount() > 0) {
+                chosenAlt = workFromHomeChoiceModelApp.getChoiceResult(randomNumber);
+            }
+            else {
+                String errorMessage = String.format("Exception caught for HHID=%d, PERSID=%d, no available WFH alternatives to choose from in choiceModelApplication.", 
+                householdObject.getHhId(), personA.getPersonId());
+                logger.error (errorMessage);
+                throw new RuntimeException();
             }
 
-            // make the simple WFH choice
-            cdapDmuObject.setWorksFromHomeForPersonA(cdapLogger);
+            // write choice model alternative info to log file
+            if ( householdObject.getDebugChoiceModels() ) {
+                // workFromHomeChoiceModelApp.logDataValues(cdapLogger, householdObject.getHhTaz(), personA.getUsualWorkLocation());
+
+                String header = "Work-From-Home Choice ";
+                String headerInfo = String.format("HHID=%d PERSID=%d personIndustry=%s ", householdObject.getHhId(), personA.getPersonId(), personIndustry);
+                headerInfo += String.format("homeTAZ=%d workTAZ=%d ", householdObject.getHhTaz(), personA.getUsualWorkLocation());
+                workFromHomeChoiceModelApp.logUECResults(cdapLogger, header + headerInfo);
+                workFromHomeChoiceModelApp.logAlternativesInfo(header, headerInfo);
+            }
+            // set it: in the UEC, Alt1 = WFH, Alt2 = Does not WFH
+            if (chosenAlt == 1) {
+                personA.setPersWorksFromHomeCategory(Person.WorkFromHomeStatus.WORKS_FROM_HOME);
+            } else if (chosenAlt == 2) {
+                personA.setPersWorksFromHomeCategory(Person.WorkFromHomeStatus.GOES_TO_WORK);
+            }
         }
 
         // get the logit model we need and clear it of any lingering probilities

core/models/ctramp/src/java/com/pb/models/ctramp/jppf/HouseholdFreeParkingModel.java

@@ -16,7 +16,7 @@
 
 public class HouseholdFreeParkingModel implements Serializable {
 
-    private transient Logger logger = Logger.getLogger(HouseholdFreeParkingModel.class);
+    private transient Logger logger = Logger.getLogger("freeparking");
 
     private static final String FP_CONTROL_FILE_TARGET = "UecFile.FreeParking";
     private static final int FP_DATA_SHEET = 0;
@@ -91,6 +91,7 @@ private int getFreeParkingChoice (Person personObj, double randomNumber) {
 
         // write choice model alternative info to log file
         if ( hhObj.getDebugChoiceModels() ) {
+            fpModel.logUECResults(logger, "Free parking Choice");
             fpModel.logAlternativesInfo("Free parking Choice", String.format("PERS_%d", personObj.getPersonId()));
             fpModel.logSelectionInfo ( "Free parking Choice", String.format("PERS_%d", personObj.getPersonId()), randomNumber, chosenAlt);
         }